Attachment 703777 Details for Bug 916438 – plugin descriptor for my custom server plugin

plugin descriptor for my custom server plugin

rhq-serverplugin.xml (text/xml), 9.06 KB, created by claudianus on 2013-02-28 04:35:49 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: claudianus

Created: 2013-02-28 04:35:49 UTC

Size: 9.06 KB

patch

obsolete

><?xml version="1.0" encoding="UTF-8" ?>
>
><generic-plugin name="AutoBundleContentsServerPlugin"
>	displayName="Auto Dicovery and Bundling Contents Processor"
>	description="Monitors content repositories, bundles and uploads newly discovered contents based on Ant recipes that are Ant scripts"
>	package="org.rhq.enterprise.server.plugins.auto.bundle" 
>	version="1.0"
>	apiVersion="2.0"
> disabledOnDiscovery="true"
>	xmlns="urn:xmlns:rhq-serverplugin.generic"
>	xmlns:serverplugin="urn:xmlns:rhq-serverplugin" 
>	xmlns:c="urn:xmlns:rhq-configuration">
>
>	<serverplugin:help><![CDATA[
>		This plugin allows the user to define local or remote content repositories such as build servers or software repositories such as GIT,
> SVN, or other content repositories where contents can be published in format consistent with what can be included in JON bundles. 
> Once a job is scheduled for a specified repo, this plugin will monitor the configured repo on the defined schedule. Upon discovery of 
> new contents, the plugin will process them, create JON compliant bundles, and upload the created bundles to JON. 
> Multiples repos can be configured and monitored on various schedules. 
> Note that when entering values for the job schedule you are required to enter empty string, using the space bar on your keyboard, 
> for all optional parameters for which you will not be providing values. We understand how inconvenient it is but for now this is the 
> only workaround to be able to schedule this jobs successfully. 
> Also note that you need to enable the plugin only after a job schedule instance has been created with all values set and the record saved.
> If you enable the plugin after creating an instance but do not enable the job instance it will not fire. 
> ]]></serverplugin:help>
>
>	<serverplugin:plugin-component class="AutoBundleContentsServerPluginComponent" />
>	
>	<serverplugin:scheduled-jobs>
>		<c:list-property name="autoBundleContentsJobs" description="A list of user-defined scheduled jobs for auto contents bundling">
>			<c:map-property name="autoBundleContentsJob" description="Monitors a content repo (disk, url...) and creates and uploads a bundle upon discovery of new content.">
>				<c:simple-property name="class" type="string" description="The name of the class that is used to process each onstance of this job. The value here is ContentMonitor." required="true" readOnly="true" default="ContentMonitor" summary="true" />
>				<c:simple-property name="methodName" type="string" description="The name of the method that will be fired on each run. Here the value is generateContentBundle. " required="true" readOnly="true" default="executeWithContext" 	summary="true" />
>				<c:simple-property name="enabled" type="boolean" required="true" default="false" summary="true" description="Whether or not the job should be scheduled" />
>				<c:simple-property name="scheduleType" type="string" required="true" default="cron" summary="true" description="Indicates when the schedule triggers">
>					<c:property-options>
>						<c:option value="periodic" />
>						<c:option value="cron" />
>					</c:property-options>
>				</c:simple-property>
>				<c:simple-property name="scheduleTrigger" type="string" required="true" default="0 0/5 * * * ?" summary="true" description="Based on the schedule type, this is either the period, in milliseconds, or the cron expression" />
>				<c:simple-property name="concurrent" type="boolean" required="true" default="false" summary="true" description="Whether or not the job can be run multiple times concurrently" />
>				<c:simple-property name="clustered" type="boolean" required="true" default="true" summary="true" description="Whether or not the job can be run on any machine in the server cluster. If false, it will always run on all machines where this plugin is deployed." />
>				<c:simple-property name="contentType" displayName="Content Repo Type" type="string" required="true" default="DiskSource" description="Type of content repository to be monitored. Can be any valid value in the list below.">
>					<c:property-options>
>						<c:option value="DiskSource" />
>						<c:option value="RemoteSource" />
>					</c:property-options>
>				</c:simple-property>
>				<c:simple-property name="artifactName" type="string" required="true" description="The name of the package to be monitored. This is can be a JON bundle zip file containing the recipe and the application artifact or it can just be the applicatcation artifact i.e. a WAR or an EAR." />
>				<c:simple-property name="rootUrl" type="string" required="true" description="The root directory, the HTTP URL or path that contains all content that is to be served by this content source. Note that for remote sources, the path should contain both the port and the protocol to use such as http, ftp, sftp, smb..." />
>				<c:simple-property name="architectureName" required="false" summary="true" description="The specific hardware architecture this type of package can be deployed on. If there is no specific architecture required, use 'noarch'. (e.g. 'i686', 'amd64')" />
>				<c:simple-property name="recipeUrl" type="string" required="false" description="Optional but empty string required. The recipe directory, the HTTP URL or path that contains the recipe if it is not located in the same repository as the content. Note that for remote sources, the path should contain both the port and the protocol to use such as http, ftp, sftp, smb..." />
>				<c:simple-property name="RecipeRepoType" displayName="Recipe Repo Type" type="string" required="false" default="DiskSource" description="Optional but empty string required. Type of content repository to be monitored. Can be any valid value in the list below.">
>					<c:property-options>
>						<c:option value="DiskSource" />
>						<c:option value="RemoteSource" />
>					</c:property-options>
>				</c:simple-property>
>				<c:simple-property name="autoDeployAlertIds" type="string" required="false" description="Optional but empty string required. Comma-separated list of auto deploy alerts to be activated so that the uploaded bundle can be auto deployed to the respective resources. Note that if this is not provided the generated bundle will be added to JON but will not be deployed to any destinations." />
>				<c:simple-property name="username" displayName="Remote Content Store Username" type="string" required="false" description="Optional but empty string required. Username used to log into the Remote Content Store server" />
>				<c:simple-property name="password" displayName="Remote Content Store Password" type="password" required="false" description="Optional but empty string required. Password used to log into the Remote Content Store server" />
>				<c:simple-property name="proxyUrl" displayName="Remote Content Store Proxy URL" type="string" required="false" description="Optional but empty string required. URL of the proxy server to use for this connection." />
>				<c:simple-property name="proxyPort" displayName="Remote Content Store Proxy Port" type="string" required="false" description="Optional but empty string required. Port of the proxy server to use for the connection to the Remote Content Store." />
>				<c:simple-property name="proxyUsername" displayName="Remote Content Store Proxy Username" type="string" required="false" description="Optional but empty string required. If the proxy to the Remote Content Store requires authentication, this is the user to log in as." />
>				<c:simple-property name="proxyPassword" displayName="Remote Content Store Proxy Password" type="password" required="false" description="Optional but empty string required. If the proxy to the Remote Content Store requires authentitcation, this is the password for the user." />
>				<c:simple-property name="recipeCSUsername" displayName=" Recipe Store Username" type="string" required="false" description="Username used to log into the recipe remote server" />
>				<c:simple-property name="recipeCSPassword" displayName="Recipe Store Password" type="password" required="false" description="Password used to log into the recipe remote server" />
>				<c:simple-property name="recipeCSProxyUrl" displayName="Recipe Store Proxy URL" type="string" required="false" description="Optional but empty string required. URL of the proxy server to use for the connection to the recipe store." />
>				<c:simple-property name="recipeCSProxyPort" displayName="Recipe Store Proxy Port" type="string" required="false" description="Optional but empty string required. Port of the proxy server to use for the connection to the recipe store." />
>				<c:simple-property name="recipeCSProxyUsername" displayName="Recipe Store Proxy Username" type="string" required="false" description="Optional but empty string required. If the recipe store proxy requires authentication, this is the user to log in as." />
>				<c:simple-property name="recipeCSProxyPassword" displayName="Recipe Store Proxy Password" type="password" required="false" description="Optional but empty string required. If the recipe store proxy requires authentitcation, this is the password for the user." />
>			</c:map-property>
>		</c:list-property>
>	</serverplugin:scheduled-jobs>
></generic-plugin>

Actions: View

Attachments on bug 916438: 703777