Package com.opencloud.slee.mlet.ant

Class RhinoManagementAntTask

  • All Implemented Interfaces:
    Cloneable
    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.

    Using the Rhino Management Ant Tasks

    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>

    Configuring the Rhino Management Ant Tasks

    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.

    Ant Task Configuration 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 trustedCertEntry to verify the identity of the Rhino node being connected to. This filename is expected to be relative to ${client.home}

    javax.net.ssl.trustStorePassword

    Password for accessing the trust store.

    javax.net.ssl.keyStore

    Name of key store file that contains a keyEntry to send to the Rhino node for it to verify the identity of this client. This filename is expected to be relative to ${client.home}

    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 slee-management task if a setactivenamespace subtask is present.

    After the subtasks have completed the active namespace reverts to the namespace that was active when the slee-management task began.

    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.

    Management Subtasks
    Task Name Description Implementation Class

    activateraentity

    Activate Resource Adaptor Entities.

    ActivateRAEntityTask

    activateservice

    Activate Services.

    ActivateServiceTask

    addappenderref

    Add log appender reference to a log key.

    AddAppenderRefTask

    addpersistenceinstanceref

    Add a persistence instance reference to a database resource.

    AddPersistenceInstanceRefTask

    addservicebindings

    Add bindings to a service.

    AddServiceBindingsTask

    bindralinkname

    Bind Resource Adaptor Entity Link Names.

    BindRALinkNameTask

    cascadeuninstall

    Cascade Uninstall.

    CascadeUninstallTask

    checkalarms

    Check Alarms.

    CheckAlarmsTask

    checkAllBundlesMapped

    Verify that all SAS bundles are mapped to prefixes.

    CheckAllBundlesMappedTask

    commandline

    Interact directly with the command line client.

    CommandLineTask

    configurelogger

    Configure a logger.

    ConfigureLoggerTask

    configurerobjectpools

    Configure object pools.

    ConfigureObjectPoolsTask

    configureratelimiter

    Configure a rate limiter.

    ConfigureRateLimiterTask

    configuresaturationlimiter

    Configure a queue saturation limiter.

    ConfigureSaturationLimiterTask

    configurestagingqueues

    Configure staging queues.

    ConfigureStagingQueuesTask

    configureabsolutestatlimiter

    Configure an absolute stat limiter.

    ConfigureAbsoluteStatLimiterTask

    configurerelativestatlimiter

    Configure a relative stat limiter.

    ConfigureRelativeStatLimiterTask

    connectraentitylimiterendpoint

    Connect a limiter endpoint (that belongs to an RA Entity) to a limiter.

    ConnectRAEntityLimiterEndpointTask

    connectservicelimiterendpoint

    Connect a limiter endpoint (that belongs to a Service) to a limiter.

    ConnectServiceLimiterEndpointTask

    copycomponent

    Make a copy of the source component with the target identity.

    CopyComponentTask

    createconsoleappender

    Create console appender.

    CreateConsoleAppenderTask

    createdatabaseresource

    Create a new database resource.

    CreateDatabaseResourceTask

    createfileappender

    Create log file appender.

    CreateFileAppenderTask

    creategenericappender

    Create log appender.

    CreateGenericAppenderTask

    createjdbcresourceconnectionpool

    Add a connection pool configuration to a JDBC resource.

    CreateJdbcResourceConnectionPoolTask

    createlimiter

    Create limiter.

    CreateLimiterTask

    createlinkedcomponent

    Create a virtual component that is a link to another component.

    CreateLinkedComponentTask

    creatememorymappedfileappender

    Create memory mapped file appender.

    CreateMemoryMappedFileAppenderTask

    createnamespace

    Create a deployment namespace.

    CreateNamespaceTask

    createpersistenceinstance

    Create a new persistence instance that can be used by a database resource.

    CreatePersistenceInstanceTask

    createprofiletable

    Create Profile Tables.

    CreateProfileTableTask

    createprofile

    Create Profiles inside tables.

    CreateProfileTask

    createraentity

    Create Resource Adaptor Entities.

    CreateRAEntityTask

    createsbbusageparameterset

    Create an sbb usage parameter set.

    CreateSbbUsageParameterSet

    createrandomaccessfileappender

    Create random access file appender.

    CreateRandomAccessFileAppenderTask

    createrollingfileappender

    Create rolling file appender.

    CreateRollingFileAppenderTask

    createrollingrandomaccessfileappender

    Create rolling random access file appender.

    CreateRollingRandomAccessFileAppenderTask

    createsocketappender

    Create log socket appender.

    CreateSocketAppenderTask

    createsyslogappender

    Create syslog appender.

    CreateSyslogAppenderTask

    createusageparameterset

    Create a usage parameter set for any notification source.

    CreateUsageParameterSetTask

    deactivateraentity

    Deactivate Resource Adaptor Entities.

    DeactivateRAEntityTask

    deactivateservice

    Deactivate Services.

    DeactivateServiceTask

    deploycomponent

    Deploy an installed component across the SLEE.

    DeployComponentTask

    deploydeployableunit

    Deploy components in an installed deployable unit across the SLEE.

    DeployDeployableUnitTask

    disablesymmetricactivationstatemode

    Disable symmetric activation state mode.

    DisableSymmetricActivationStateModeTask

    disablerampup

    Disable rampup of limiter rate for the system input limiter.

    DisableRampUpTask

    disconnectraentitylimiterendpoint

    Disconnect a limiter endpoint (that belongs to an RA Entity).

    DisconnectRAEntityLimiterEndpointTask

    disconnectservicelimiterendpoint

    Disconnect a limiter endpoint (that belongs to a Service).

    DisconnectServiceLimiterEndpointTask

    enablesymmetricactivationstatemode

    Enable symmetric activation state mode.

    EnableSymmetricActivationStateModeTask

    enablerampup

    Enable ramp up of limiter rate for the system input limiter.

    EnableRampUpTask

    importconfiguration

    Import Rhino Configuration.

    ImportConfigurationKeyTask

    importprofiles

    Import Profiles from XML Data.

    ImportProfilesTask

    install

    Install Deployable Units.

    InstallTask

    removeappenderref

    Remove log appender reference from a log key.

    RemoveAppenderRefTask

    removecopiedcomponents

    Remove copied components.

    RemoveCopiedComponentsTask

    removedatabaseresource

    Remove an existing database resource.

    RemoveDatabaseResourceTask

    removejdbcresourceconnectionpool

    Remove the connection pool configuraton from a JDBC resource.

    RemoveJdbcResourceConnectionPoolTask

    removelimiter

    Remove limiter.

    RemoveLimiterTask

    removelinkedcomponent

    Remove a linked component.

    RemoveLinkedComponentTask

    removeloggerconfig

    Remove a logger configuration.

    RemoveLoggerConfigTask

    removenamespace

    Remove a deployment namespace.

    RemoveNamespaceTask

    removepersistenceinstance

    Remove a persistence instance.

    RemovePersistenceInstanceTask

    removepersistenceinstanceref

    Remove a persistence instance reference from a database resource.

    RemovePersistenceInstanceRefTask

    removeprofiletable

    Remove Profile Tables.

    RemoveProfileTableTask

    removeprofile

    Remove a Profile from a table.

    RemoveProfileTask

    removeraentity

    Remove Resource Adaptor Entities.

    RemoveRAEntityTask

    removesbbusageparameterset

    Remove a sbb usage parameter set.

    RemoveSbbUsageParameterSet

    removeusageparameterset

    Remove a usage parameter set for any notification source.

    RemoveUsageParameterSetTask

    removeservicebindings

    Remove bindings from a service.

    RemoveServiceBindingsTask

    setactivenamespace

    Set the active deployment namespace.

    SetActiveNamespaceTask

    setadditivity

    Set the additivity for a log key.

    SetAdditivityTask

    setjdbcresourceconnectionpoolconfig

    Update the connection pool configuration of a JDBC resource.

    SetJdbcResourceConnectionPoolConfigTask

    setloglevel

    Set the log level of a Rhino log.

    SetLogLevelTask

    setprofileattributes

    Modify profile attributes.

    SetProfileAttributesTask

    setraentitystartingpriority

    Set the starting priority of a Resource Adaptor Entity.

    SetRAEntityStartingPriorityTask

    setraentitystoppingpriority

    Set the stopping priority of a Resource Adaptor Entity.

    SetRAEntityStoppingPriorityTask

    setservicemetricsrecordingenabled

    Update the service metrics recording status of a service.

    SetServiceMetricsRecordingEnabledTask

    setserviceinitialpersistence

    Update the initial persistence status of a service.

    SetServiceInitialPersistenceTask

    setservicereplicationselectors

    Set the replication selectors of a service.

    SetServiceReplicationSelectorsTask

    setservicestartingpriority

    Set the starting priority of a Service..

    SetServiceStartingPriorityTask

    setservicestoppingpriority

    Set the stopping priority of a Service..

    SetServiceStoppingPriorityTask

    settracelevel

    Set the trace level of components.

    SetTraceLevelTask

    settracerlevel

    Set the trace level for notification source tracers.

    SetTracerLevelTask

    configuresas

    Set the hostname/address and the resource-identifier for the SAS server.

    ConfigureSasTask

    setservicedesiredstate

    Set the desired state of a Service.

    SetServiceDesiredStateTask

    setsastracingenabled

    Set the state of the SAS tracing.

    SetSasTracingEnabledTask

    setraentitydesiredstate

    Set the desired state of a Resource Adaptor Entity.

    SetRAEntityDesiredStateTask

    shadowcomponent

    Shadow a component with another component.

    ShadowComponentTask

    unbindralinkname

    Unbind Resource Adaptor Entity Link Names.

    UnbindRALinkNameTask

    undeploycomponent

    Undeploys a deployed component across the SLEE.

    UndeployComponentTask

    uninstall

    Uninstall Deployable Units.

    UninstallTask

    updatepersistenceinstance

    Update the configuration settings of a persistence instance.

    UpdatePersistenceInstanceTask

    unsetalltracers

    Unset the trace level assigned to all non-root tracers for a notification source.

    UnsetAllTracersTask

    usertransaction

    Run nested tasks inside a single user transaction.

    UserTransactionTask

    unshadowcomponent

    Remove the shadow from a shadowed component..

    UnshadowComponentTask

    unverifycomponent

    Unverifies a verified component.

    UnverifyComponentTask

    verifycomponent

    Verify an installed component.

    VerifyComponentTask

    verifydeployableunit

    Verify components in an installed deployable unit.

    VerifyDeployableUnitTask

    waittilconverged

    Wait until configuration has converged to desired state.

    WaitTilConvergedTask

    waittilraentityisinactive

    Wait on Resource Adaptor deactivation.

    WaitTilRAEntityIsInactiveTask

    waittilserviceisinactive

    Wait on Service deactivation.

    WaitTilServiceIsInactiveTask
    Ant Parameters
    Attribute Description Required

    failonerror

    Sets the default failure behaviour for subtasks. If 'true', a subtask will throw a BuildException when an error is encountered. If 'false', the subtask will throw a NonFatalBuildException instead of a BuildException under specific circumstances. See the description of each subtasks for the conditions (if any) which will cause a NonFatalBuildException.

    No, default is 'false'