com.adobe.idp.applicationmanager.client
Class ApplicationManager

java.lang.Object
  ApplicationManagerClient
      com.adobe.idp.applicationmanager.client.ApplicationManager

public class ApplicationManager
extends ApplicationManagerClient

This class is used to create and consume LiveCycle ES Application archives.

Constructor Summary

ApplicationManager(ServiceClientFactory serviceClientFactory)
Creates an Application Manager client.

Method Summary

ApplicationStatus	exportApplicationArchive(ApplicationDocument applicationDescriptorXmlBean) Creates and returns a valid archive populated with the application components specified in the application descriptor parameter.
Application	getApplication(ApplicationId applicationId) Retrieves the specified LiveCycle ES application.
java.util.List	getApplications() Retrieves a list of all the deployed applications.
java.util.List	getApplications(int offset, int size) Retrieves a list of all the deployed applications, and uses the offset and size parameters for paging.
ApplicationStatus	getApplicationStatus(ApplicationId applicationId) Retrieves the deployment status of the application component and the application as a whole.
ApplicationStatus	importApplicationArchive(byte[] applicationArchiveByteArray) Imports the archive specified by the application archive parameter.
ApplicationStatus	importApplicationArchive(Document applicationArchiveDocument) Imports the archive specified by the application archive parameter.
ApplicationStatus	importApplicationArchive(Document applicationArchiveDocument, ImportApplicationInfo importApplicationInfo) Imports the archive specified by the application archive parameter.
ApplicationStatus	previewApplicationArchive(byte[] applicationArchiveByteArray) Provides a preview (prior to import) of the archive specified by the application archive parameter.
ApplicationStatus	previewApplicationArchive(Document applicationArchiveDocument) Provides a preview (prior to import) of the archive specified by the application archive parameter.
ApplicationStatus	previewExportApplicationArchive(ApplicationDocument applicationDescriptorXmlBean) Creates and returns an archive preview with the application components specified in the application descriptor parameter.
ApplicationStatus	removeApplication(ApplicationId applicationId) Removes the application specified by the application identifier parameter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationManager

public ApplicationManager(ServiceClientFactory serviceClientFactory)

Creates an Application Manager client.

Parameters:

serviceClientFactory - The service client factory needed to create an instance of the Application Manager client

Method Detail

previewExportApplicationArchive

public ApplicationStatus previewExportApplicationArchive(ApplicationDocument applicationDescriptorXmlBean)
                                                  throws ApplicationManagerException

Creates and returns an archive preview with the application components specified in the application descriptor parameter. the return value is an ApplicationStatus object, which provides a preview of the export status of each application component and the application as a whole. The application status instance will not contain a Document for the application.

Parameters:

applicationDescriptorXmlBean - A valid LiveCycle ES application descriptor XML bean.

Returns:

An ApplicationStatus object providing a preview of the status of each application component and the application as a whole.

Throws:

ApplicationManagerException - if any errors occur during the creation of the archive.

exportApplicationArchive

public ApplicationStatus exportApplicationArchive(ApplicationDocument applicationDescriptorXmlBean)
                                           throws ApplicationManagerException

Creates and returns a valid archive populated with the application components specified in the application descriptor parameter. The return value is an ApplicationStatus object, which describes the export status of each application component and the application as a whole. If the operation is successful, the returned object will also contain a Document containing a portable, serializable reference to the bits of the requested archive.

Parameters:

applicationDescriptorXmlBean - A valid LiveCycle ES application descriptor XML bean.

Returns:

An ApplicationStatus object describing the status of each application component and the application as a whole.

Throws:

ApplicationManagerException - if any errors occur during the creation of the archive.

importApplicationArchive

public ApplicationStatus importApplicationArchive(byte[] applicationArchiveByteArray)
                                           throws ApplicationManagerException

Imports the archive specified by the application archive parameter. The imported archive is represented by a byte array containing a portable, serializable reference to the bits of the specified archive. The application components within the archive will be deployed following the declarations in the application descriptor contained in the archive. The application components will be deployed in the following order: repository resources, components,processes and service configurations(configuration parameters, endpoints and security profiles). The return value is an ApplicationStatus object, which describes the deployment status of each application component and the application as a whole. If successful, the returned object will also contain the Application object, including its identifier, which can be used to reference the application in other application management operations.

Parameters:

applicationArchiveByteArray - A byte array containing a valid compressed archive.

Returns:

An ApplicationStatus object describing the status of each application component and the application as a whole.

Throws:

ApplicationManagerException - if any errors occur during the deployment of the archive and its application components.

importApplicationArchive

public ApplicationStatus importApplicationArchive(Document applicationArchiveDocument)
                                           throws ApplicationManagerException

Imports the archive specified by the application archive parameter. The imported archive is represented by a Document containing a portable, serializable reference to the bits of the specified archive. The application components within the archive will be deployed following the declarations in the application descriptor contained in the archive. The application components will be deployed in the following order: repository resources, components,processes and service configurations(configuration parameters, endpoints and security profiles). The return value is an ApplicationStatus object, which describes the deployment status of each application component and the application as a whole. If successful, the returned object will also contain the Application object, including its identifier, which can be used to reference the application in other application management operations.

Parameters:

applicationArchiveDocument - A Document containing a valid compressed archive.

Returns:

An ApplicationStatus object describing the status of each application component and the application as a whole.

Throws:

ApplicationManagerException - if any errors occur during the deployment of the archive and its application components.

importApplicationArchive

public ApplicationStatus importApplicationArchive(Document applicationArchiveDocument,
                                                  ImportApplicationInfo importApplicationInfo)
                                           throws ApplicationManagerException

Imports the archive specified by the application archive parameter. The imported archive is represented by a Document containing a portable, serializable reference to the bits of the specified archive. The application components within the archive will be deployed following the declarations in the application descriptor contained in the archive. The application components will be deployed in the following order: repository resources, components,processes and service configurations(configuration parameters, endpoints and security profiles). The return value is an ApplicationStatus object, which describes the deployment status of each application component and the application as a whole. If successful, the returned object will also contain the Application object, including its identifier, which can be used to reference the application in other application management operations.

Parameters:

applicationArchiveDocument - A Document containing a valid compressed archive.

ImportApplicationInfo - the settings to be used for import of the application archive.

Returns:

An ApplicationStatus object describing the status of each application component and the application as a whole.

Throws:

ApplicationManagerException - if any errors occur during the deployment of the archive and its application components.

previewApplicationArchive

public ApplicationStatus previewApplicationArchive(byte[] applicationArchiveByteArray)
                                            throws ApplicationManagerException

Provides a preview (prior to import) of the archive specified by the application archive parameter. The preview is intended to describe what actions would be taken during a subsequent import operation on the same application archive.

The application components within the archive will be previewed following the declarations in the application descriptor contained in the archive. The application components will be previewed in the following order: repository resources, components, and processes. The return value is an ApplicationStatus object, which describes the preview status of each application component and the application as a whole.

Parameters:

applicationArchiveByteArray - A byte array containing a valid compressed archive.

Returns:

An ApplicationStatus object describing the status of each application component and the application as a whole.

Throws:

ApplicationManagerException - if any errors occur during the preview of the archive and its application components.

previewApplicationArchive

public ApplicationStatus previewApplicationArchive(Document applicationArchiveDocument)
                                            throws ApplicationManagerException

Provides a preview (prior to import) of the archive specified by the application archive parameter. The preview is intended to describe what actions would be taken during a subsequent import operation on the same application archive.

The application components within the archive will be previewed following the declarations in the application descriptor contained in the archive. The application components will be previewed in the following order: repository resources, components, and processes. The return value is an ApplicationStatus object, which describes the preview status of each application component and the application as a whole.

Parameters:

applicationArchiveDocument - A Document containing a valid compressed archive.

Returns:

An ApplicationStatus object describing the status of each application component and the application as a whole.

Throws:

ApplicationManagerException - if any errors occur during the preview of the archive and its application components.

removeApplication

public ApplicationStatus removeApplication(ApplicationId applicationId)
                                    throws ApplicationManagerException,
                                           ApplicationNotFoundException

Removes the application specified by the application identifier parameter. The application components within the specified application will be undeployed if they are not referenced by other deployed applications. The application components will be undeployed in the following order: orchestrations, components, and processes. The return value is an ApplicationStatus object, which describes the deployment status of each application component and the application as a whole.

Parameters:

applicationId - The application identifier.

Returns:

An ApplicationStatus object describing the status of each application component and the application as a whole.

Throws:

ApplicationNotFoundException - if the specified application is not found

ApplicationManagerException - if any errors occur during the removal of the archive and its application components.

getApplicationStatus

public ApplicationStatus getApplicationStatus(ApplicationId applicationId)
                                       throws ApplicationManagerException,
                                              ApplicationNotFoundException

Retrieves the deployment status of the application component and the application as a whole.

Parameters:

applicationId - The application identifier.

Returns:

An ApplicationStatus object describing the status of the application component and the application as a whole.

Throws:

ApplicationNotFoundException - if the specified application is not found.

ApplicationManagerException - if any errors occur during the retrieval of the application status.

getApplication

public Application getApplication(ApplicationId applicationId)
                           throws ApplicationManagerException,
                                  ApplicationNotFoundException

Retrieves the specified LiveCycle ES application.

Parameters:

applicationId - The application identifier.

Returns:

An Application object representing the requested LiveCycle ES application.

Throws:

ApplicationNotFoundException - if the specified application is not found.

ApplicationManagerException - if any errors occur during the retrieval of the application.

getApplications

public java.util.List getApplications()
                               throws ApplicationManagerException

Retrieves a list of all the deployed applications.

Returns:

A java.util.List of Application objects representing the deployed applications.

Throws:

ApplicationManagerException - if any errors occur during the retrieval of the list of applications.

getApplications

public java.util.List getApplications(int offset,
                                      int size)
                               throws ApplicationManagerException

Retrieves a list of all the deployed applications, and uses the offset and size parameters for paging.

Parameters:

offset - The offset for the returned set of applications, from the start of the complete set.

size - The number of application objects to be returned, starting from the offset.

Returns:

A java.util.List of Application objects representing the deployed applications.

Throws:

ApplicationManagerException - if any errors occur during the retrieval of the list of applications.