SISManagementTask (SIS-SIP Management API 2.6)

java.lang.Object
- org.apache.tools.ant.ProjectComponent
- - org.apache.tools.ant.Task
  - - com.opencloud.slee.resources.sis.management.ant.SISManagementTask

All Implemented Interfaces:: Cloneable

Direct Known Subclasses:: SipSISManagementTask

public class SISManagementTask
extends org.apache.tools.ant.Task

SIS Management Ant Task. Executes a series of sub-tasks to perform management operations on a SIS RA entity.

This task establishes a connection to a SIS RA entity or, if one is available, uses an existing connection from a previous SIS 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 connection parameters (host, port, username, password, and raentity) only need to be specified once per Ant session. Subsequent invovations of this task in the same Ant session will reuse the last successful connection. Further, the host, port, username and password parameters can be set automatically from Ant properties, see the table below. The raentity parameter must be specified the first time this task is invoked, so that a connection is established to a SIS RA entity MBean.

Ant Parameters

Attribute	Description	Required
host	Hostname or IP address of Rhino node	Only for the first use of the connection in each Ant session. May be omitted if ${rhino.remote.host} property is defined instead.
port	Port for the RMI management interface.	Only for the first use of the connection in each Ant session. May be omitted if ${rhino.remote.port} property is defined instead.
username	User for the RMI management interface.	Only for the first use of the connection in each Ant session. May be omitted if ${rhino.remote.user} property is defined instead.
password	Password for the RMI management interface.	Only for the first use of the connection in each Ant session. May be omitted if ${rhino.remote.password} property is defined instead.
raentity	Name of the SIS RA entity to manage.	Only for the first use of the connection in each Ant session.
failifmissing	Failure case behaviour if the specified SIS RA entity does not exist, if set to 'false' or 'no', the build will continue (without executing any sub tasks) if the client cannot connect to the SIS RA entity.	No, default is 'true'
failonerror	Default failure case behaviour for subtasks, if set to 'false' or 'no', the build will continue when a sub task attempts a redundant action.	No, default is 'false'

Subtasks specified as nested elements

The following sub task elements can be provided in any number and in any order. The SIS management task will execute these sub tasks in the specified order until a sub task fails by throwing a BuildException, which will be re-thrown to Ant with some contextual information regarding the sub task that caused it.

Element	Description
`installmacro`	Installs a SIS macro component from a file.
`uninstallmacro`	Uninstalls a deployed SIS macro component.
`replacemacro`	Replaces a deployed SIS macro component with new content from a file.
`installtrigger`	Installs a SIS trigger component from a file.
`uninstalltrigger`	Uninstalls a deployed SIS trigger component.
`replacemacro`	Replaces a deployed SIS trigger component with new content from a file.
`activatetrigger`	Activates a SIS trigger component.
`deactivatetrigger`	Deactivates a SIS trigger component.
`installcomposition`	Installs a SIS composition component from a file.
`uninstallcomposition`	Uninstalls a deployed SIS composition component.
`replacemacro`	Replaces a deployed SIS composition component with new content from a file.
`setdefaultservicetimeout`	Set the SIS default service timeout.
`setfinegrainedtracing`	Enabled or disable fine-grained tracing.
`setauditlevel`	Sets the amount of audit logging that the SIS will generate.
`createextensionref`	Creates a SIS extension reference.
`replaceextensionref`	Replaces an existing SIS extension reference.
`removeextensionref`	Removes a SIS extension reference.
`updateextensionref`	Update configurable properties of a SIS extension reference.
`replaceserviceref`	Replaces an existing SIS service reference.
`removeserviceref`	Removes a SIS service reference.
`createexternalplatform`	Creates a SIS external platform definition.
`removeexternalplatform`	Removes a SIS external platform definition.
`addexternalplatformaddress`	Adds a SIP or IN address to an external platform definition.
`activateexternalplatformaddress`	Activates an address in an external platform definition.
`deactivateexternalplatformaddress`	Deactivates an address in an external platform definition.
`removeexternalplatformaddress`	Remove a SIP or IN address from an external platform definition.
`setaddresssubscriptionprofiletablename`	Sets the name of the SIS address subscriptions profile table.
`installaddresssubscription`	Installs a SIS address subscription.
`updateaddresssubscription`	Updates an existing SIS address subscription.
`uninstalladdresssubscription`	Uninstalls a SIS address subscription.
`createnetworkinterface`	Creates a SIS network interface definition.
`updatenetworkinterface`	Updates a existing SIS network interface definition.
`removenetworkinterface`	Removes a SIS network interface definition.
`enablenetworkinterface`	Enables a network interface in a SIS instance..
`disablenetworkinterface`	Disables a network interface in a SIS instance..
`addnetworkroute`	Adds a SIS network route.
`updatenetworkroute`	Updates an existing SIS network route.
`removenetworkroute`	Removes a SIS network route.
`adddefaultnetworkroute`	Adds a default SIS network route.
`updatedefaultnetworkroute`	Updates an existing default SIS network route.
`removedefaultnetworkroute`	Removes a default SIS network route.
`settriggeraddressdebuglevel`	Sets the fine-grained tracing debug level associated with a trigger address.
`enableexperimentalfeature`	Enables an experimental feature in a SIS instance.
`disableexperimentalfeature`	Disables an experimental feature in a SIS instance.
`reload`	Reloads the SIS configuration. Required for changes to take effect.

Constructor Summary

Constructors
Constructor and Description

SISManagementTask()

Constructors
Constructor and Description
`SISManagementTask()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addActivateExternalPlatformAddress(ActivateExternalPlatformAddressTask task)`
`void`	`addActivateTrigger(ActivateTriggerTask task)`
`void`	`addAddDefaultNetworkRoute(AddDefaultNetworkRouteTask task)`
`void`	`addAddExternalPlatformAddress(AddExternalPlatformAddressTask task)`
`void`	`addAddNetworkRoute(AddNetworkRouteTask task)`
`void`	`addCreateExtensionRef(CreateExtensionRefTask task)`
`void`	`addCreateExternalPlatform(CreateExternalPlatformTask task)`
`void`	`addCreateInterceptorRef(CreateInterceptorRefTask task)`
`void`	`addCreateNetworkInterface(CreateNetworkInterfaceTask task)`
`void`	`addDeactivateExternalPlatformAddress(DeactivateExternalPlatformAddressTask task)`
`void`	`addDeactivateTrigger(DeactivateTriggerTask task)`
`void`	`addDisableExperimentalFeature(DisableExperimentalFeatureTask task)`
`void`	`addDisableNetworkInterface(DisableNetworkInterfaceTask task)`
`void`	`addEnableExperimentalFeature(EnableExperimentalFeatureTask task)`
`void`	`addEnableNetworkInterface(EnableNetworkInterfaceTask task)`
`void`	`addInstallAddressSubscription(InstallAddressSubscriptionTask task)`
`void`	`addInstallComposition(InstallCompositionTask task)`
`void`	`addInstallInterceptor(InstallInterceptorTask task)`
`void`	`addInstallMacro(InstallMacroTask task)`
`void`	`addInstallTrigger(InstallTriggerTask task)`
`void`	`addReload(ReloadTask task)`
`void`	`addRemoveDefaultNetworkRoute(RemoveDefaultNetworkRouteTask task)`
`void`	`addRemoveExtensionRef(RemoveExtensionRefTask task)`
`void`	`addRemoveExternalPlatform(RemoveExternalPlatformTask task)`
`void`	`addRemoveExternalPlatformAddress(RemoveExternalPlatformAddressTask task)`
`void`	`addRemoveInterceptorRef(RemoveInterceptorRefTask task)`
`void`	`addRemoveNetworkInterface(RemoveNetworkInterfaceTask task)`
`void`	`addRemoveNetworkRoute(RemoveNetworkRouteTask task)`
`void`	`addRemoveServiceRef(RemoveServiceRefTask task)`
`void`	`addReplaceComposition(ReplaceCompositionTask task)`
`void`	`addReplaceExtensionRef(ReplaceExtensionRefTask task)`
`void`	`addReplaceInterceptor(ReplaceInterceptorTask task)`
`void`	`addReplaceInterceptorRef(ReplaceInterceptorRefTask task)`
`void`	`addReplaceMacro(ReplaceMacroTask task)`
`void`	`addReplaceServiceRef(ReplaceServiceRefTask task)`
`void`	`addReplaceTrigger(ReplaceTriggerTask task)`
`void`	`addSetAddressSubscriptionsProfileTableName(SetAddressSubscriptionsProfileTableNameTask task)`
`void`	`addSetAuditLevel(SetAuditLevelTask task)`
`void`	`addSetDefaultServiceTimeout(SetDefaultServiceTimeoutTask task)`
`void`	`addSetFineGrainedTracing(SetFineGrainedTracingTask task)`
`void`	`addSetTriggerAddressAuditLogging(SetTriggerAddressAuditLoggingTask task)`
`void`	`addSetTriggerAddressDebugLevel(SetTriggerAddressDebugLevelTask task)`
`void`	`addUninstallAddressSubscription(UninstallAddressSubscriptionTask task)`
`void`	`addUninstallComposition(UninstallCompositionTask task)`
`void`	`addUninstallInterceptor(UninstallInterceptorTask task)`
`void`	`addUninstallMacro(UninstallMacroTask task)`
`void`	`addUninstallTrigger(UninstallTriggerTask task)`
`void`	`addUpdateAddressSubscription(UpdateAddressSubscriptionTask task)`
`void`	`addUpdateDefaultNetworkRoute(UpdateDefaultNetworkRouteTask task)`
`void`	`addUpdateExtensionRef(UpdateExtensionRefTask task)`
`void`	`addUpdateExternalPlatform(UpdateExternalPlatformTask task)`
`void`	`addUpdateNetworkInterface(UpdateNetworkInterfaceTask task)`
`void`	`addUpdateNetworkRoute(UpdateNetworkRouteTask task)`
`void`	`execute()`
`boolean`	`getFailOnError()`
`void`	`setFailIfMissing(boolean failIfMissing)`
`void`	`setFailOnError(boolean failOnError)`
`void`	`setHost(String host)`
`void`	`setPassword(String password)`
`void`	`setPort(int port)`
`void`	`setRaentity(String ra)`
`void`	`setUsername(String username)`

Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, init, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SISManagementTask
```
public SISManagementTask()
```

Method Detail

execute
```
public void execute()
             throws org.apache.tools.ant.BuildException
```
Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

setHost
```
public void setHost(String host)
```

setPort
```
public void setPort(int port)
```

setUsername

public void setUsername(String username)

setPassword

public void setPassword(String password)

setRaentity
```
public void setRaentity(String ra)
```

getFailOnError
```
public boolean getFailOnError()
```

setFailOnError

public void setFailOnError(boolean failOnError)

setFailIfMissing

public void setFailIfMissing(boolean failIfMissing)

addInstallMacro

public void addInstallMacro(InstallMacroTask task)

addUninstallMacro

public void addUninstallMacro(UninstallMacroTask task)

addReplaceMacro

public void addReplaceMacro(ReplaceMacroTask task)

addInstallTrigger

public void addInstallTrigger(InstallTriggerTask task)

addUninstallTrigger

public void addUninstallTrigger(UninstallTriggerTask task)

addReplaceTrigger

public void addReplaceTrigger(ReplaceTriggerTask task)

addActivateTrigger

public void addActivateTrigger(ActivateTriggerTask task)

addDeactivateTrigger

public void addDeactivateTrigger(DeactivateTriggerTask task)

addInstallComposition

public void addInstallComposition(InstallCompositionTask task)

addUninstallComposition

public void addUninstallComposition(UninstallCompositionTask task)

addReplaceComposition

public void addReplaceComposition(ReplaceCompositionTask task)

addInstallInterceptor

public void addInstallInterceptor(InstallInterceptorTask task)

addUninstallInterceptor

public void addUninstallInterceptor(UninstallInterceptorTask task)

addReplaceInterceptor

public void addReplaceInterceptor(ReplaceInterceptorTask task)

addCreateInterceptorRef

public void addCreateInterceptorRef(CreateInterceptorRefTask task)

addReplaceInterceptorRef

public void addReplaceInterceptorRef(ReplaceInterceptorRefTask task)

addRemoveInterceptorRef

public void addRemoveInterceptorRef(RemoveInterceptorRefTask task)

addSetDefaultServiceTimeout

public void addSetDefaultServiceTimeout(SetDefaultServiceTimeoutTask task)

addSetFineGrainedTracing

public void addSetFineGrainedTracing(SetFineGrainedTracingTask task)

addSetAuditLevel

public void addSetAuditLevel(SetAuditLevelTask task)

addCreateExtensionRef

public void addCreateExtensionRef(CreateExtensionRefTask task)

addReplaceExtensionRef

public void addReplaceExtensionRef(ReplaceExtensionRefTask task)

addRemoveExtensionRef

public void addRemoveExtensionRef(RemoveExtensionRefTask task)

addUpdateExtensionRef

public void addUpdateExtensionRef(UpdateExtensionRefTask task)

addReplaceServiceRef

public void addReplaceServiceRef(ReplaceServiceRefTask task)

addRemoveServiceRef

public void addRemoveServiceRef(RemoveServiceRefTask task)

addCreateExternalPlatform

public void addCreateExternalPlatform(CreateExternalPlatformTask task)

addUpdateExternalPlatform

public void addUpdateExternalPlatform(UpdateExternalPlatformTask task)

addRemoveExternalPlatform

public void addRemoveExternalPlatform(RemoveExternalPlatformTask task)

addAddExternalPlatformAddress

public void addAddExternalPlatformAddress(AddExternalPlatformAddressTask task)

addActivateExternalPlatformAddress

public void addActivateExternalPlatformAddress(ActivateExternalPlatformAddressTask task)

addDeactivateExternalPlatformAddress

public void addDeactivateExternalPlatformAddress(DeactivateExternalPlatformAddressTask task)

addRemoveExternalPlatformAddress

public void addRemoveExternalPlatformAddress(RemoveExternalPlatformAddressTask task)

addSetAddressSubscriptionsProfileTableName

public void addSetAddressSubscriptionsProfileTableName(SetAddressSubscriptionsProfileTableNameTask task)

addInstallAddressSubscription

public void addInstallAddressSubscription(InstallAddressSubscriptionTask task)

addUninstallAddressSubscription

public void addUninstallAddressSubscription(UninstallAddressSubscriptionTask task)

addUpdateAddressSubscription

public void addUpdateAddressSubscription(UpdateAddressSubscriptionTask task)

addSetTriggerAddressDebugLevel

public void addSetTriggerAddressDebugLevel(SetTriggerAddressDebugLevelTask task)

addSetTriggerAddressAuditLogging

public void addSetTriggerAddressAuditLogging(SetTriggerAddressAuditLoggingTask task)

addCreateNetworkInterface

public void addCreateNetworkInterface(CreateNetworkInterfaceTask task)

addUpdateNetworkInterface

public void addUpdateNetworkInterface(UpdateNetworkInterfaceTask task)

addRemoveNetworkInterface

public void addRemoveNetworkInterface(RemoveNetworkInterfaceTask task)

addEnableNetworkInterface

public void addEnableNetworkInterface(EnableNetworkInterfaceTask task)

addDisableNetworkInterface

public void addDisableNetworkInterface(DisableNetworkInterfaceTask task)

addAddNetworkRoute

public void addAddNetworkRoute(AddNetworkRouteTask task)

addUpdateNetworkRoute

public void addUpdateNetworkRoute(UpdateNetworkRouteTask task)

addRemoveNetworkRoute

public void addRemoveNetworkRoute(RemoveNetworkRouteTask task)

addAddDefaultNetworkRoute

public void addAddDefaultNetworkRoute(AddDefaultNetworkRouteTask task)

addUpdateDefaultNetworkRoute

public void addUpdateDefaultNetworkRoute(UpdateDefaultNetworkRouteTask task)

addRemoveDefaultNetworkRoute

public void addRemoveDefaultNetworkRoute(RemoveDefaultNetworkRouteTask task)

addEnableExperimentalFeature

public void addEnableExperimentalFeature(EnableExperimentalFeatureTask task)

addDisableExperimentalFeature

public void addDisableExperimentalFeature(DisableExperimentalFeatureTask task)

addReload

public void addReload(ReloadTask task)

Class SISManagementTask