Field Detail

• CONFIGURE_XML

  static final java.lang.String CONFIGURE_XML

  Constant representing the name of the property containing an optional configure.xml text

  See Also:

  Constant Field Values

• LOGICAL_AND_PROP

  static final java.lang.String LOGICAL_AND_PROP

  Constant representing the name of the logical AND property

  See Also:

  Constant Field Values

Method Detail

• archiveDeploy

  void archiveDeploy(java.lang.String archiveName,
                   java.util.List<ArchiveLocator> archiveLocators,
                   java.util.Properties properties)
                     throws java.lang.Exception

  Deploy an archive.

  Parameters:

  archiveName - the name of the archive to deploy

  archiveLocators - the locators from which to download the archive. The utility method ContainerUtils.retrieveAndConfigureArchiveFile may be used to download and configure the archive.

  properties - properties associated with this deploy operation

  Throws:

  java.lang.Exception - if there is an error deploying the archive

  See Also:

  ContainerUtils.retrieveAndConfigureArchiveFile(Container, String, List, Properties)

• archiveStart

  ArchiveActivationInfo archiveStart(java.lang.String archiveName,
                                   java.util.Properties properties)
                                     throws java.lang.Exception

  Start an archive.

  Parameters:

  archiveName - the name of the archive to start

  properties - properties associated with this start operation

  Returns:

  An ArchiveActivationInfo object containing the ID of the archive instance that was started.

  Throws:

  java.lang.Exception

• archiveScaleUp

  ArchiveActivationInfo archiveScaleUp(java.lang.String archiveName,
                                     java.util.List<ArchiveLocator> archiveLocators)
                                       throws java.lang.Exception

  Scale up an instance of the given archive.

  Parameters:

  archiveName - the name of archive to scale

  archiveLocators - the locators from which to download the archive. This may be null if the archive is not physically available and the scale up operation is to be done by name only. If locators are specified, the utility method ContainerUtils.retrieveAndConfigureArchiveFile may be used to download and configure the archive.

  Returns:

  An ArchiveActivationInfo object containing the ID of the archive instance that was scaled.

  Throws:

  java.lang.Exception - if there is an error scaling up an instance of the archive

• archiveScaleDown

  void archiveScaleDown(java.lang.String archiveName,
                      java.lang.String archiveId)
                        throws java.lang.Exception

  Scale down the instance of the archive.

  Parameters:

  archiveName - the archive to remove

  archiveId - the archive instance to remove

  Throws:

  java.lang.Exception - if there is an error scaling down the archive instance

• archiveStop

  void archiveStop(java.lang.String archiveName,
                 java.lang.String archiveId,
                 java.util.Properties properties)
                   throws java.lang.Exception

  Stop an archive instance.

  Parameters:

  archiveName - the name of the archive to stop

  archiveId - the ID of the archive instance to stop

  properties - properties associated with this stop operation

  Throws:

  java.lang.Exception - if there is an error stopping this archive instance

• archiveUndeploy

  void archiveUndeploy(java.lang.String archiveName,
                     java.util.Properties properties)
                       throws java.lang.Exception

  Undeploy an archive.

  Parameters:

  archiveName - the name of the archive to undeploy

  properties - properties associated with this undeploy operation

  Throws:

  java.lang.Exception - if there is an error undeploying this archive

• archiveDetect

  ArchiveDetail[] archiveDetect()
                                throws java.lang.Exception

  Detect currently active archives. This method will be called to allow an Enabler to express the current set of deployed, running, and scaled archives on the Engine. This will be called in the following cases:

  1. On Component activation
  2. Subsequent to successful completion of archiveDeploy(), archiveStart(), archiveScaleUp(), archiveScaleDown(), archiveStop(), and archiveUndeploy().
  3. When the ARCHIVE_DETECTION_ENABLED runtime context variable is true; how often it will be called based on the ARCHIVE_DETECTION_FREQUENCY variable.

  Returns:

  an array of ArchiveDetail objects containing information about running archives.

  Throws:

  java.lang.Exception - if there is an error detecting archives

• urlDetect

  java.lang.String[] urlDetect()
                               throws java.lang.Exception

  Detect current context URLs. This method will be called to allow an Enabler to express the current set of URLs being handled by the enabler. This will be called in the following cases, subsequent to archiveDetect():

  1. On Component activation
  2. Subsequent to successful completion of archiveDeploy(), archiveStart(), archiveScaleUp(), archiveScaleDown(), archiveStop(), and archiveUndeploy().
  3. When the ARCHIVE_DETECTION_ENABLED runtime context variable is true; how often it will be called based on the ARCHIVE_DETECTION_FREQUENCY variable.

  Returns:

  an array of String containing current context URLs.

  Throws:

  java.lang.Exception - if there is an error detecting URLs