ArchiveManagement (TIBCO Software, Inc.)

```
public interface ArchiveManagement
```
The ArchiveManagement interface must be implemented by Enablers that support the "Archive Management Support" feature. This interface defines methods that will be called for the various archive lifecycle operations:
- deploy
- start
- stop
- scaleUp
- scaleDown
- undeploy
These methods can alternatively be implemented in a script.
See Also:
ArchiveDetail, ArchiveProvider, ArchiveActivationInfo, ArchiveLocator, ArchiveManagementFeatureInfo

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONFIGURE_XML` Constant representing the name of the property containing an optional configure.xml text
`static String`	`LOGICAL_AND_PROP` Constant representing the name of the logical AND property

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`archiveDeploy(String archiveName, List<ArchiveLocator> archiveLocators, Properties properties)` Deploy an archive.
`ArchiveDetail[]`	`archiveDetect()` Detect currently active archives.
`void`	`archiveScaleDown(String archiveName, String archiveId)` Scale down the instance of the archive.
`ArchiveActivationInfo`	`archiveScaleUp(String archiveName, List<ArchiveLocator> archiveLocators)` Scale up an instance of the given archive.
`ArchiveActivationInfo`	`archiveStart(String archiveName, Properties properties)` Start an archive.
`void`	`archiveStop(String archiveName, String archiveId, Properties properties)` Stop an archive instance.
`void`	`archiveUndeploy(String archiveName, Properties properties)` Undeploy an archive.
`String[]`	`urlDetect()` Detect current context URLs.

- Field Detail
  - CONFIGURE_XML
```
static final 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 String LOGICAL_AND_PROP
```
    Constant representing the name of the logical AND property
    
    See Also:
    Constant Field Values
- Method Detail
  - archiveDeploy
```
void archiveDeploy(String archiveName,
                 List<ArchiveLocator> archiveLocators,
                 Properties properties)
                   throws 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:
    
    Exception - if there is an error deploying the archive
    See Also:
    ContainerUtils.retrieveAndConfigureArchiveFile(Container, String, List, Properties)
  - archiveStart
```
ArchiveActivationInfo archiveStart(String archiveName,
                                 Properties properties)
                                   throws 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:
    
    Exception
  - archiveScaleUp
```
ArchiveActivationInfo archiveScaleUp(String archiveName,
                                   List<ArchiveLocator> archiveLocators)
                                     throws 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:
    
    Exception - if there is an error scaling up an instance of the archive
  - archiveScaleDown
```
void archiveScaleDown(String archiveName,
                    String archiveId)
                      throws Exception
```
    Scale down the instance of the archive.
    
    Parameters:
    archiveName - the archive to remove
    archiveId - the archive instance to remove
    
    Throws:
    
    Exception - if there is an error scaling down the archive instance
  - archiveStop
```
void archiveStop(String archiveName,
               String archiveId,
               Properties properties)
                 throws 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:
    
    Exception - if there is an error stopping this archive instance
  - archiveUndeploy
```
void archiveUndeploy(String archiveName,
                   Properties properties)
                     throws Exception
```
    Undeploy an archive.
    
    Parameters:
    archiveName - the name of the archive to undeploy
    properties - properties associated with this undeploy operation
    
    Throws:
    
    Exception - if there is an error undeploying this archive
  - archiveDetect
```
ArchiveDetail[] archiveDetect()
                              throws 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:
    
    Exception - if there is an error detecting archives
  - urlDetect
```
String[] urlDetect()
                   throws 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:
    
    Exception - if there is an error detecting URLs

Interface ArchiveManagement

Field Summary

Method Summary

Field Detail

CONFIGURE_XML

LOGICAL_AND_PROP

Method Detail

archiveDeploy

archiveStart

archiveScaleUp

archiveScaleDown

archiveStop

archiveUndeploy

archiveDetect

urlDetect