Metaswitch has developed custom Ant tasks for Rhino which can be used in Ant build scripts to deploy and configure SLEE components, including: packaging, deployment, services, resource adaptors, and profiles.

Below are examples of specific Ant tasks: install, createraentity, and activateservice.

Tip The full set of Rhino Ant management tasks is available in the Rhino Management API.

install

install is a Rhino management sub-task for installing deployable units.

Parameters

install takes the following Ant parameters (attributes for Ant tasks).

Parameter Description Required Default 
 failonerror

Flag to control failure behaviour.

  • If true, the sub-task will throw a BuildException when an error is encountered.

  • If false, the sub-task will throw a NonFatalBuildException instead of a BuildException under specific circumstances.

No.

Taken from the Rhino management parent task.

 
 url

URL deployable unit to install.

Not if srcfile is specified.

 
 srcfile

Path to deployable unit to install.

Not if url is specified.
Example

For example, to install a deployable unit with a SIP resource adaptor, the build.xml file would contain:

<target name="install-ocjainsip-1.2-ra-du" depends="login">
  <slee-management>
    <install srcfile="units/ocjainsip-1.2-ra.jar"
             url="file:lib/ocjainsip-1.2-ra.jar"/>
  </slee-management>
</target>

createraentity

createraentity is a Rhino management sub-task for creating resource adaptor entities.

Parameters

createraentity takes the following Ant parameters:

Parameter Description Required Default 
 failonerror

Flag to control failure behaviour.

  • If true, the sub-task will throw a BuildException when an error is encountered.

  • If false, the sub-task will throw a NonFatalBuildException instead of a BuildException under specific circumstances.

No.

Taken from the Rhino management parent task.

 
 entityname

Name of the resource adaptor entity to create — must be unique within the SLEE.

Yes.

 
 resourceadaptorid

Canonical name of the resource adaptor component from which the entity should be created.

Only required (or allowed) if the component nested element is not present.

 
 properties

Properties to be set on the resource adaptor.

No.

 
 component

Element that identifies the resource adaptor component from which the resource adaptor entity should be created. Available as a nested element. (See sleecomponentelement.)

Only required (or allowed) if the resourceadaptorid is not present.
Example

For example, to create a SIP resource adaptor entity, the `build.xml `file would contain:

<target name="create-ra-entity-sipra" depends="install-ocjainsip-1.2-ra-du">
  <slee-management>
    <createraentity entityname="sipra"
                    properties="ListeningPoints=0.0.0.0:5060/udp;0.0.0.0:5060/tcp,ExtensionMethods=,OutboundProxy=,
                                UDPThreads=1,TCPThreads=1,OffsetPorts=False,PortOffset=101,RetransmissionFilter=False,
                                AutomaticDialogSupport=False,Keystore=sip-ra-ssl.keystore,KeystoreType=jks,KeystorePassword=,
                                Truststore=sip-ra-ssl.truststore,TruststoreType=jks,TruststorePassword=,CRLURL=,CRLRefreshTimeout=86400,
                                CRLLoadFailureRetryTimeout=900,CRLNoCRLLoadFailureRetryTimeout=60,ClientAuthentication=NEED,
                                MaxContentLength=131072">
      <component name="OCSIP" vendor="Open Cloud" version="1.2"/>
    </createraentity>
    <bindralinkname entityname="sipra" linkname="OCSIP"/>
  </slee-management>
</target>

sleecomponentelement

A sleecomponentelement is an XML element that can be nested as a child in some of other Ant task, to give it a SLEE-component reference. It takes the following form:

<component name="name" vendor="vendor" version="version"/>

Below is the DTD definition:

<!ELEMENT component EMPTY>
<!ATTLIST component
          id ID #IMPLIED
          version CDATA #IMPLIED
          name CDATA #IMPLIED
          type CDATA #IMPLIED
          vendor CDATA #IMPLIED>

activateservice

activateservice is a Rhino management sub-task for activating services.

Parameters

activateservice takes the following Ant parameters.

Parameter Description Required Default 
 failonerror

Flag to control failure behaviour.

  • If true, the sub-task will throw a BuildException when an error is encountered.

  • If false, the sub-task will throw a NonFatalBuildException instead of a BuildException under specific circumstances.

No.

Taken from the Rhino management parent task.

 
 serviceid

Canonical name of the service to activate.

Only required (or allowed) if the component nested element is not present.

 
 component

Element that identifies the service to activate. Available as a nested element. (See sleecomponentelement.)

Only required (or allowed) if the `serviceid is not present.

 
 nodes

Comma-separated list of node IDs on which the service should be activated.

No.

If not specified, the service is activated on all currently live Rhino event router nodes.
Example

For example, to activate three services based on the SIP protocol, the build.xml file might contain:

<target name="activate-services" depends="install-sip-ac-location-service-du,install-sip-registrar-service-du,install-sip-proxy-service-du">
  <slee-management>
    <activateservice>
      <component name="SIP AC Location Service" vendor="Open Cloud" version="1.5"/>
    </activateservice>
    <activateservice>
      <component name="SIP Registrar Service" vendor="Open Cloud" version="1.5"/>
    </activateservice>
    <activateservice>
      <component name="SIP Proxy Service" vendor="Open Cloud" version="1.5"/>
    </activateservice>
  </slee-management>
</target>
Previous page Next page
Rhino Version 3.1