<property name="client.home" value="/path/to/rhino/client/directory"/>
<import file="${client.home}/etc/common.xml"/>
public class RhinoManagementAntTask extends BaseAntTask
The Rhino management task executes a series of subtasks to perform management operations against Rhino.
This task either establishes a connection to a Rhino node or, if one is available, uses an existing connection from a previous Rhino management task that ran in the same Ant session. Connections are not disconnected at the end of a task, rather they are kept open for possible subsequent tasks and only disconnected when the entire Ant build is complete.
The Rhino Management Ant Tasks can be used by setting the client.home
Ant property to the path of the client
directory in your Rhino install, then importing from ${client.home}/etc/common.xml
. For example:
<property name="client.home" value="/path/to/rhino/client/directory"/>
<import file="${client.home}/etc/common.xml"/>
This defines the slee-management
tasks.
Build targets using this task can then be written with a dependency (direct or indirect) on the login
target (defined in common.xml
). For example:
<target name="install-du" depends="login">
<slee-management>
<install srcfile="/path/to/deployable-unit.jar" url="file:url/to/install/deployable/unit/as"/>
</slee-management>
</target>
The following properties may be specified in an Ant build file to configure the slee-management
task.
If a value of a property is not specified then the task uses the value defined in ${client.home}/etc/client.properties
.
Property | Description |
---|---|
rhino.remote.host |
Host name or IP address of Rhino node to connect to. |
rhino.remote.port |
RMI registry port configured for the JMX Remote M-Let on the Rhino node being connected to. |
rhino.remote.username |
Name of user to connect as. |
rhino.remote.password |
User’s password. |
javax.net.ssl.trustStore |
Name of key store file that contains a |
javax.net.ssl.trustStorePassword |
Password for accessing the trust store. |
javax.net.ssl.keyStore |
Name of key store file that contains a |
javax.net.ssl.keyStorePassword |
Password for accessing the key store. |
namespace |
The Rhino namespace that the enclosed tasks should be run within. Use an empty string value to denote the default namespace.
Note that the active namespace could still be changed within the After the subtasks have completed the active namespace reverts to the namespace that was active when the If this property is not specified then the subtasks are run using whatever namespace is currently active for the Rhino connection. |
Management subtasks are specified as nested elements of the slee-management
task.
The following subtasks can be provided in any number and in any order.
The slee-management
task will execute these subtasks in the given order until all have been executed or a subtask fails by throwing a BuildException
. The BuildException
will be re-thrown to Ant with some contextual information regarding the subtask that caused it.
Refer to the javadoc for each subtask for details on its supported parameters.
Task Name | Description | Implementation Class |
---|---|---|
activateraentity |
Activate Resource Adaptor Entities. |
|
activateservice |
Activate Services. |
|
addappenderref |
Add log appender reference to a log key. |
|
addpersistenceinstanceref |
Add a persistence instance reference to a database resource. |
|
addservicebindings |
Add bindings to a service. |
|
bindralinkname |
Bind Resource Adaptor Entity Link Names. |
|
cascadeuninstall |
Cascade Uninstall. |
|
checkalarms |
Check Alarms. |
|
checkAllBundlesMapped |
Verify that all SAS bundles are mapped to prefixes. |
|
commandline |
Interact directly with the command line client. |
|
configurelogger |
Configure a logger. |
|
configurerobjectpools |
Configure object pools. |
|
configureratelimiter |
Configure a rate limiter. |
|
configuresaturationlimiter |
Configure a queue saturation limiter. |
|
configurestagingqueues |
Configure staging queues. |
|
connectraentitylimiterendpoint |
Connect a limiter endpoint (that belongs to an RA Entity) to a limiter. |
|
connectservicelimiterendpoint |
Connect a limiter endpoint (that belongs to a Service) to a limiter. |
|
copycomponent |
Make a copy of the source component with the target identity. |
|
createconsoleappender |
Create console appender. |
|
createdatabaseresource |
Create a new database resource. |
|
createfileappender |
Create log file appender. |
|
creategenericappender |
Create log appender. |
|
createjdbcresourceconnectionpool |
Add a connection pool configuration to a JDBC resource. |
|
createlimiter |
Create limiter. |
|
createlinkedcomponent |
Create a virtual component that is a link to another component. |
|
creatememorymappedfileappender |
Create memory mapped file appender. |
|
createnamespace |
Create a deployment namespace. |
|
createpersistenceinstance |
Create a new persistence instance that can be used by a database resource. |
|
createprofiletable |
Create Profile Tables. |
|
createprofile |
Create Profiles inside tables. |
|
createraentity |
Create Resource Adaptor Entities. |
|
createsbbusageparameterset |
Create an sbb usage parameter set. |
|
createrandomaccessfileappender |
Create random access file appender. |
|
createrollingfileappender |
Create rolling file appender. |
|
createrollingrandomaccessfileappender |
Create rolling random access file appender. |
|
createsocketappender |
Create log socket appender. |
|
createsyslogappender |
Create syslog appender. |
|
createusageparameterset |
Create a usage parameter set for any notification source. |
|
deactivateraentity |
Deactivate Resource Adaptor Entities. |
|
deactivateservice |
Deactivate Services. |
|
deploycomponent |
Deploy an installed component across the SLEE. |
|
deploydeployableunit |
Deploy components in an installed deployable unit across the SLEE. |
|
disablesymmetricactivationstatemode |
Disable symmetric activation state mode. |
|
disablerampup |
Disable rampup of limiter rate for the system input limiter. |
|
disconnectraentitylimiterendpoint |
Disconnect a limiter endpoint (that belongs to an RA Entity). |
|
disconnectservicelimiterendpoint |
Disconnect a limiter endpoint (that belongs to a Service). |
|
enablesymmetricactivationstatemode |
Enable symmetric activation state mode. |
|
enablerampup |
Enable ramp up of limiter rate for the system input limiter. |
|
importconfiguration |
Import Rhino Configuration. |
|
importprofiles |
Import Profiles from XML Data. |
|
install |
Install Deployable Units. |
|
removeappenderref |
Remove log appender reference from a log key. |
|
removecopiedcomponents |
Remove copied components. |
|
removedatabaseresource |
Remove an existing database resource. |
|
removejdbcresourceconnectionpool |
Remove the connection pool configuraton from a JDBC resource. |
|
removelimiter |
Remove limiter. |
|
removelinkedcomponent |
Remove a linked component. |
|
removeloggerconfig |
Remove a logger configuration. |
|
removenamespace |
Remove a deployment namespace. |
|
removepersistenceinstance |
Remove a persistence instance. |
|
removepersistenceinstanceref |
Remove a persistence instance reference from a database resource. |
|
removeprofiletable |
Remove Profile Tables. |
|
removeprofile |
Remove a Profile from a table. |
|
removeraentity |
Remove Resource Adaptor Entities. |
|
removesbbusageparameterset |
Remove a sbb usage parameter set. |
|
removeusageparameterset |
Remove a usage parameter set for any notification source. |
|
removeservicebindings |
Remove bindings from a service. |
|
setactivenamespace |
Set the active deployment namespace. |
|
setadditivity |
Set the additivity for a log key. |
|
setjdbcresourceconnectionpoolconfig |
Update the connection pool configuration of a JDBC resource. |
|
setloglevel |
Set the log level of a Rhino log. |
|
setprofileattributes |
Modify profile attributes. |
|
setraentitystartingpriority |
Set the starting priority of a Resource Adaptor Entity. |
|
setraentitystoppingpriority |
Set the stopping priority of a Resource Adaptor Entity. |
|
setservicemetricsrecordingenabled |
Update the service metrics recording status of a service. |
|
setservicereplicationselectors |
Set the replication selectors of a service. |
|
setservicestartingpriority |
Set the starting priority of a Service.. |
|
setservicestoppingpriority |
Set the stopping priority of a Service.. |
|
settracelevel |
Set the trace level of components. |
|
settracerlevel |
Set the trace level for notification source tracers. |
|
configuresas |
Set the hostname/address and the resource-identifier for the SAS server. |
|
setsastracingenabled |
Set the state of the SAS tracing. |
|
shadowcomponent |
Shadow a component with another component. |
|
unbindralinkname |
Unbind Resource Adaptor Entity Link Names. |
|
undeploycomponent |
Undeploys a deployed component across the SLEE. |
|
uninstall |
Uninstall Deployable Units. |
|
updatepersistenceinstance |
Update the configuration settings of a persistence instance. |
|
unsetalltracers |
Unset the trace level assigned to all non-root tracers for a notification source. |
|
usertransaction |
Run nested tasks inside a single user transaction. |
|
unshadowcomponent |
Remove the shadow from a shadowed component.. |
|
unverifycomponent |
Unverifies a verified component. |
|
verifycomponent |
Verify an installed component. |
|
verifydeployableunit |
Verify components in an installed deployable unit. |
|
waittilraentityisinactive |
Wait on Resource Adaptor deactivation. |
|
waittilserviceisinactive |
Wait on Service deactivation. |
Attribute | Description | Required |
---|---|---|
failonerror |
Sets the default failure behaviour for subtasks.
If 'true', a subtask will throw a |
No, default is 'false' |
Constructor and Description |
---|
RhinoManagementAntTask() |
getAlarm, getClient, getDeployment, getFailOnError, getLogging, getProfileProvisioning, getResourceManagement, getRhinoInspector, getServerHost, getServerPort, getServiceManagement, getSleeManagement, getTrace, getUserTransactionManagement, logout, setFailOnError, setHost, setKeyStore, setKeyStorePass, setPassword, setPort, setRmissl, setTrustStore, setTrustStorePass, setUsername
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
public void execute() throws org.apache.tools.ant.BuildException
Execute the task, called by Ant
execute
in class BaseAntTask
org.apache.tools.ant.BuildException
public void addActivateRAEntity(ActivateRAEntityTask task)
public void addEnableRampUp(EnableRampUpTask task)
public void addActivateService(ActivateServiceTask task)
public void addAddAppenderRef(AddAppenderRefTask task)
public void addAddPermissionMapping(AddPermissionMappingTask task)
public void addAddPermissionToRole(AddPermissionToRoleTask task)
public void addAddPersistenceInstanceRef(AddPersistenceInstanceRefTask task)
public void addAddServiceBindings(AddServiceBindingsTask task)
public void addBindRALinkName(BindRALinkNameTask task)
public void addCascadeUninstall(CascadeUninstallTask task)
public void addCheckAlarms(CheckAlarmsTask task)
public void addCheckAllBundlesMapped(CheckAllBundlesMappedTask task)
public void addCommandLine(CommandLineTask task)
public void addConfigureLogger(ConfigureLoggerTask task)
public void addConfigureObjectPools(ConfigureObjectPoolsTask task)
public void addConfigureRateLimiter(ConfigureRateLimiterTask task)
public void addConfigureSaturationLimiter(ConfigureSaturationLimiterTask task)
public void addConfigureStagingQueues(ConfigureStagingQueuesTask task)
public void addConnectRAEntityLimiterEndpoint(ConnectRAEntityLimiterEndpointTask task)
public void addConnectServiceLimiterEndpoint(ConnectServiceLimiterEndpointTask task)
public void addCopyComponent(CopyComponentTask task)
public void addCreateConsoleAppender(CreateConsoleAppenderTask task)
public void addCreateFileAppender(CreateFileAppenderTask task)
public void addCreateGenericAppender(CreateGenericAppenderTask task)
public void addCreateMemoryMappedFileAppender(CreateMemoryMappedFileAppenderTask task)
public void addCreateRandomAccessFileAppender(CreateRandomAccessFileAppenderTask task)
public void addCreateRollingFileAppender(CreateRollingFileAppenderTask task)
public void addCreateRollingRandomAccessFileAppender(CreateRollingRandomAccessFileAppenderTask task)
public void addCreateDatabaseResource(CreateDatabaseResourceTask task)
public void addCreateJdbcResourceConnectionPool(CreateJdbcResourceConnectionPoolTask task)
public void addCreateLimiter(CreateLimiterTask task)
public void addCreateLinkedComponent(CreateLinkedComponentTask task)
public void addCreateNamespace(CreateNamespaceTask task)
public void addCreatePersistenceInstance(CreatePersistenceInstanceTask task)
public void addCreateProfile(CreateProfileTask task)
public void addCreateProfileTable(CreateProfileTableTask task)
public void addCreateRAEntity(CreateRAEntityTask task)
public void addCreateRole(CreateRoleTask task)
public void addCreateSbbUsageParameterSet(CreateSbbUsageParameterSet task)
public void addCreateSocketAppender(CreateSocketAppenderTask task)
public void addCreateSyslogAppender(CreateSyslogAppenderTask task)
public void addCreateUsageParameterSet(CreateUsageParameterSetTask task)
public void addDeactivateRAEntity(DeactivateRAEntityTask task)
public void addDeactivateService(DeactivateServiceTask task)
public void addDeployComponent(DeployComponentTask task)
public void addDeployDeployableUnit(DeployDeployableUnitTask task)
public void addDisableSymmetricActivationStateMode(DisableSymmetricActivationStateModeTask task)
public void addDisableRampUp(DisableRampUpTask task)
public void addDisconnectRAEntityLimiterEndpoint(DisconnectRAEntityLimiterEndpointTask task)
public void addDisconnectServiceLimiterEndpoint(DisconnectServiceLimiterEndpointTask task)
public void addEnableSymmetricActivationStateMode(EnableSymmetricActivationStateModeTask task)
public void addImportConfiguration(ImportConfigurationKeyTask task)
public void addImportProfiles(ImportProfilesTask task)
public void addInstall(InstallTask task)
public void addAddLoggerComponent(AddLoggerComponentTask task)
public void addRemoveAppenderRef(RemoveAppenderRefTask task)
public void addRemoveCopiedComponents(RemoveCopiedComponentsTask task)
public void addRemoveDatabaseResource(RemoveDatabaseResourceTask task)
public void addRemoveJdbcResourceConnectionPool(RemoveJdbcResourceConnectionPoolTask task)
public void addRemoveNamespace(RemoveNamespaceTask task)
public void addRemoveLimiter(RemoveLimiterTask task)
public void addRemoveLinkedComponent(RemoveLinkedComponentTask task)
public void addRemoveLoggerConfig(RemoveLoggerConfigTask task)
public void addRemovePermissionFromRole(RemovePermissionFromRoleTask task)
public void addRemovePermissionMapping(RemovePermissionMappingTask task)
public void addRemovePersistenceInstance(RemovePersistenceInstanceTask task)
public void addRemovePersistenceInstanceRef(RemovePersistenceInstanceRefTask task)
public void addRemoveProfile(RemoveProfileTask task)
public void addRemoveProfileTable(RemoveProfileTableTask task)
public void addRemoveRAEntity(RemoveRAEntityTask task)
public void addRemoveRole(RemoveRoleTask task)
public void addRemoveSbbUsageParameterSet(RemoveSbbUsageParameterSet task)
public void addRemoveUsageParameterSet(RemoveUsageParameterSetTask task)
public void addRemoveServiceBindings(RemoveServiceBindingsTask task)
public void addSetActiveNamespace(SetActiveNamespaceTask task)
public void addSetAdditivity(SetAdditivityTask task)
public void addSetSecurityPolicy(SetSecurityPolicy task)
public void addSetEnvEntries(SetEnvEntries task)
public void addSetJdbcResourceConnectionPoolConfig(SetJdbcResourceConnectionPoolConfigTask task)
public void addSetLogLevel(SetLogLevelTask task)
public void addSetProfileAttributes(SetProfileAttributesTask task)
public void addSetRAEntityStartingPriority(SetRAEntityStartingPriorityTask task)
public void addSetRAEntityStoppingPriority(SetRAEntityStoppingPriorityTask task)
public void addSetServiceMetricsRecordingEnabled(SetServiceMetricsRecordingEnabledTask task)
public void addSetServiceReplicationSelectors(SetServiceReplicationSelectorsTask task)
public void addSetServiceStartingPriority(SetServiceStartingPriorityTask task)
public void addSetServiceStoppingPriority(SetServiceStoppingPriorityTask task)
public void addSetTraceLevel(SetTraceLevelTask task)
public void addSetTracerLevel(SetTracerLevelTask task)
public void addConfigureSas(ConfigureSasTask task)
public void addSetSASTracingEnabled(SetSasTracingEnabledTask task)
public void addSetSasBundleMapping(SetSasBundleMappingTask task)
public void addRemoveSasBundleMapping(RemoveSasBundleMappingTask task)
public void addShadowComponent(ShadowComponentTask task)
public void addUndeployComponent(UndeployComponentTask task)
public void addUnsetAllTracers(UnsetAllTracersTask task)
public void addUnbindRALinkName(UnbindRALinkNameTask task)
public void addUninstall(UninstallTask task)
public void addUnshadowComponent(UnshadowComponentTask task)
public void addUnverifyComponent(UnverifyComponentTask task)
public void addUpdatePersistenceInstance(UpdatePersistenceInstanceTask task)
public void addUserTransaction(UserTransactionTask task)
public void addVerifyComponent(VerifyComponentTask task)
public void addVerifyDeployableUnit(VerifyDeployableUnitTask task)
public void addWaitTilRAEntityIsInactive(WaitTilRAEntityIsInactiveTask task)
public void addWaitTilServiceIsInactive(WaitTilServiceIsInactiveTask task)
public void addSetLoggingProperties(SetLoggingPropertiesTask task)
public void addRemoveLoggingProperty(RemoveLoggingPropertyTask task)
public void setNamespace(String namespace)