| Package | com.adobe.idp.applicationmanager.client |
| Class | public class ApplicationManager |
| Inheritance | ApplicationManager  ApplicationManagerClient |
| Method | Defined By | ||
|---|---|---|---|
ApplicationManager(ServiceClientFactory serviceClientFactory) Creates an Application Manager client. | ApplicationManager | ||
ApplicationStatus exportApplicationArchive(ApplicationDocument applicationDescriptorXmlBean) Creates and returns a valid archive populated with the application components specified in the application descriptor parameter. | ApplicationManager | ||
Retrieves the specified LiveCycle ES application. | ApplicationManager | ||
List getApplications() Retrieves a list of all the deployed applications. | ApplicationManager | ||
List getApplications(int offset, int size) Retrieves a list of all the deployed applications, and uses the offset and size parameters for paging. | ApplicationManager | ||
Retrieves the deployment status of the application component and the application as a whole. | ApplicationManager | ||
ApplicationStatus importApplicationArchive(byte[] applicationArchiveByteArray) Imports the archive specified by the application archive parameter. | ApplicationManager | ||
Imports the archive specified by the application archive parameter. | ApplicationManager | ||
ApplicationStatus importApplicationArchive(Document applicationArchiveDocument, ImportApplicationInfo importApplicationInfo) Imports the archive specified by the application archive parameter. | ApplicationManager | ||
ApplicationStatus previewApplicationArchive(byte[] applicationArchiveByteArray) Provides a preview (prior to import) of the archive specified by the application archive parameter. | ApplicationManager | ||
Provides a preview (prior to import) of the archive specified by the application archive parameter. | ApplicationManager | ||
ApplicationStatus previewExportApplicationArchive(ApplicationDocument applicationDescriptorXmlBean) Creates and returns an archive preview with the application components specified in the application descriptor parameter. | ApplicationManager | ||
Removes the application specified by the application identifier parameter. | ApplicationManager | ||
| ApplicationManager | () |
public ApplicationManager(ServiceClientFactory serviceClientFactory)Creates an Application Manager client.
ParametersserviceClientFactory — The service client factory needed to create an instance of the Application Manager client |
| exportApplicationArchive | () |
public ApplicationStatus exportApplicationArchive(ApplicationDocument applicationDescriptorXmlBean)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 com.adobe.idp.Document containing a portable, serializable reference to the bits of the requested archive.
Parameters
applicationDescriptorXmlBean — A valid LiveCycle ES application descriptor XML bean. |
| An ApplicationStatus object describing the status of each application component and the application as a whole. |
ApplicationManagerException — if any errors occur during the creation of the archive. |
| getApplication | () |
public Application getApplication(ApplicationId applicationId)Retrieves the specified LiveCycle ES application.
Parameters
applicationId — The application identifier. |
| An Application object representing the requested LiveCycle ES application. |
ApplicationNotFoundException — if the specified application is not found. | |
ApplicationManagerException — if any errors occur during the retrieval of the application. |
| getApplications | () |
public List getApplications()Retrieves a list of all the deployed applications.
ReturnsA java.util.List of Application objects representing the deployed applications. |
ApplicationManagerException — if any errors occur during the retrieval of the list of applications. |
| getApplications | () |
public List getApplications(int offset, int size)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. |
A java.util.List of Application objects representing the deployed applications. |
ApplicationManagerException — if any errors occur during the retrieval of the list of applications. |
| getApplicationStatus | () |
public ApplicationStatus getApplicationStatus(ApplicationId applicationId)Retrieves the deployment status of the application component and the application as a whole.
Parameters
applicationId — The application identifier. |
| An ApplicationStatus object describing the status of the application component and the application as a whole. |
ApplicationNotFoundException — if the specified application is not found. | |
ApplicationManagerException — if any errors occur during the retrieval of the application status. |
| importApplicationArchive | () |
public ApplicationStatus importApplicationArchive(byte[] applicationArchiveByteArray)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. |
| An ApplicationStatus object describing the status of each application component and the application as a whole. |
ApplicationManagerException — if any errors occur during the deployment of the archive and its application components. |
| importApplicationArchive | () |
public ApplicationStatus importApplicationArchive(Document applicationArchiveDocument)Imports the archive specified by the application archive parameter. The imported archive is represented by a com.adobe.idp.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 com.adobe.idp.Document containing a valid compressed archive. |
| An ApplicationStatus object describing the status of each application component and the application as a whole. |
ApplicationManagerException — if any errors occur during the deployment of the archive and its application components. |
| importApplicationArchive | () |
public ApplicationStatus importApplicationArchive(Document applicationArchiveDocument, ImportApplicationInfo importApplicationInfo)Imports the archive specified by the application archive parameter. The imported archive is represented by a com.adobe.idp.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 com.adobe.idp.Document containing a valid compressed archive. | |
importApplicationInfo — the settings to be used for import of the application archive. |
| An ApplicationStatus object describing the status of each application component and the application as a whole. |
ApplicationManagerException — if any errors occur during the deployment of the archive and its application components. |
| previewApplicationArchive | () |
public ApplicationStatus previewApplicationArchive(byte[] applicationArchiveByteArray)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. |
| An ApplicationStatus object describing the status of each application component and the application as a whole. |
ApplicationManagerException — if any errors occur during the preview of the archive and its application components. |
| previewApplicationArchive | () |
public ApplicationStatus previewApplicationArchive(Document applicationArchiveDocument)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 com.adobe.idp.Document containing a valid compressed archive. |
| An ApplicationStatus object describing the status of each application component and the application as a whole. |
ApplicationManagerException — if any errors occur during the preview of the archive and its application components. |
| previewExportApplicationArchive | () |
public ApplicationStatus previewExportApplicationArchive(ApplicationDocument applicationDescriptorXmlBean)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 com.adobe.idp.Document for the application.
Parameters
applicationDescriptorXmlBean — A valid LiveCycle ES application descriptor XML bean. |
| An ApplicationStatus object providing a preview of the status of each application component and the application as a whole. |
ApplicationManagerException — if any errors occur during the creation of the archive. |
| removeApplication | () |
public ApplicationStatus removeApplication(ApplicationId applicationId)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. |
| An ApplicationStatus object describing the status of each application component and the application as a whole. |
ApplicationNotFoundException — if the specified application is not found | |
ApplicationManagerException — if any errors occur during the removal of the archive and its application components. |
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/idp/applicationmanager/client/ApplicationManager.html