|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ApplicationService
Method Summary | |
---|---|
boolean |
activate(java.lang.String applicationID) This API service method activates an application in the system |
Application |
create(Application application) This API service method creates a new Application in the system |
OperationResult |
create(Application application, java.util.List appObjectclasses) This API service method creates a new Application with its objectclasses in the system. |
boolean |
deactivate(java.lang.String applicationID) This API service method deactivates an application in the system |
boolean |
delete(java.lang.String applicationID) This API service method soft-deletes an application in the system. |
java.util.List |
findApplication(SearchCriteria searchCriteria, java.util.HashMap configParams) This API service method provides a mechanism of getting an Application details by specifying a search criteria. |
Application |
findApplicationByID(java.lang.String applicationID) This API service method provides a mechanism of getting an Application details by ID. |
Application |
findApplicationByName(java.lang.String applicationName) This API service method provides a mechanism of getting an Application details by name. |
java.util.List |
getConfiguredApplicationObjectclasses(java.lang.String applicationID) This API service method returns a list of all the ApplicationObjectclasses configured for a specific Application. |
java.util.List |
getSupportedApplicationObjectclasses(Application application) This API service method returns a list of all the ApplicationObjectclasses supported by the Application. |
Application |
modify(Application application) This API service method modifies the configuration of an Application already present in the system |
OperationResult |
modify(Application application, java.util.List appObjectclasses) This API service method modifies the configuration of an Application and its objectclasses that already exist in the system |
void |
testConnection(java.lang.String applicationID) This API service method will check whether the connection to the actual target can be successfully performed or not. |
Method Detail |
---|
Application create(Application application) throws DuplicateApplicationException, AuthorizationFailedException, GenericAppConfigException
application
- - The Application
value object that contains configuration of the Application to be created.OperationResult
vo. If the Application is successfully created, then the OperationResult Vo contains the entityID of the Application.DuplicateApplicationException
- If an Application by the name already exists in the systemAuthorizationFailedException
- If any authorization error occurs while creating the ApplicationGenericAppConfigException
- Any other error while persisting the Application configuration in the system.OperationResult create(Application application, java.util.List appObjectclasses) throws DuplicateApplicationException, DuplicateApplicationObjectclassException, AuthorizationFailedException, GenericAppConfigException
application
- - The Application
value object that contains configuration of the Application to be created.appObjectclasses
- - A list of ApplicationObjectclass
value objects that contain the ApplicationObjectclass configuration to be created in the system.OperationResult
vo. If the Application is successfully created, then the OperationResult Vo contains the entityID of the Application. If any of the ApplicationObjectclass creation fails, then the getFailedResults() returns the failed entities with additional failure details. The getSucceededResults() returns the entityIDs of the successfully created entities.DuplicateApplicationException
- If an Application by the name already exists in the systemDuplicateApplicationObjectclassException
- If an Application Objectclass having the same name as any one of the Application Objectclasses to be created already exists in the systemAuthorizationFailedException
- If any authorization error occurs while creating the ApplicationGenericAppConfigException
- Any other error while persisting the Application configuration in the system.Application modify(Application application) throws NoSuchEntityException, AuthorizationFailedException, GenericAppConfigException
application
- - The Application
value object that holds the new configuration of the Application to be modified.OperationResult
vo. If the Application is successfully modified, then the OperationResult Vo contains the entityID of the Application and the appropriate status code.NoSuchEntityException
- If the Application to be modified does not exist in the system.AuthorizationFailedException
- If any authorization error occurs while modifying the Application.GenericAppConfigException
- Any other error while persisting the Application configuration in the system.OperationResult modify(Application application, java.util.List appObjectclasses) throws NoSuchEntityException, AuthorizationFailedException, GenericAppConfigException
application
- - The Application
value object that holds the new configuration of the Application to be modified.appObjectclasses
- - A list of ApplicationObjectclass
value objects that contain the ApplicationObjectclass configuration to be modified.OperationResult
vo. If the Application is successfully modified, then the OperationResult Vo contains the entityID of the Application. If any of the ApplicationObjectclass modification fails, then the getFailedResults() returns the failed entities with additional failure details. The getSucceededResults() returns the entityIDs of the successfully modified entities.NoSuchEntityException
- If the Application or any of the ApplicationObjectclasses to be modified do not exist in the system.AuthorizationFailedException
- If any authorization error occurs while modifying the Application.GenericAppConfigException
- Any other error while persisting the Application configuration in the system.boolean activate(java.lang.String applicationID) throws NoSuchEntityException, AuthorizationFailedException, GenericAppConfigException
applicationID
- - The Application ID of the Application to be activated.NoSuchEntityException
- If the Application to be activated does not exist in the system.AuthorizationFailedException
- If any authorization error occurs while activating the ApplicationGenericAppConfigException
- Any other error while activating the Application in the system.boolean deactivate(java.lang.String applicationID) throws NoSuchEntityException, AuthorizationFailedException, GenericAppConfigException
applicationID
- - The Application ID of the Application to be deactivated.NoSuchEntityException
- If the Application to be deactivated does not exist in the system.AuthorizationFailedException
- If any authorization error occurs while deactivating the ApplicationGenericAppConfigException
- Any other error while deactivating the Application in the system.boolean delete(java.lang.String applicationID) throws NoSuchEntityException, AuthorizationFailedException, GenericAppConfigException
applicationID
- - The Application ID of the Application to be deleted.NoSuchEntityException
- If the Application to be deleted does not exist in the system.AuthorizationFailedException
- If any authorization error occurs while deleted the ApplicationGenericAppConfigException
- Any other error while deleted the Application in the system.void testConnection(java.lang.String applicationID) throws NoSuchEntityException, AuthorizationFailedException, ConnectorException
applicationID
- - The Application ID of the Application for which to perform test the connectivity.NoSuchEntityException
- If the Application to check target connectivity does not exist in the system.AuthorizationFailedException
- If any authorization error occurs while performing testConnection on the ApplicationConnectorException
- If any error occurs while performing test connection, either from ICF, the connector bundle, or the actual target itself.Application findApplicationByName(java.lang.String applicationName) throws AuthorizationFailedException, GenericAppConfigException
applicationName
- - The name of the ApplicationApplication
vo. If the Application is found, then the Application
VO contains the application configuration. This API will return a null if the Application by the specified name is not found in the system.AuthorizationFailedException
- If the logged in user does not have authorization to get the application details.GenericAppConfigException
- Any other error while performing the search operation.Application findApplicationByID(java.lang.String applicationID) throws AuthorizationFailedException, GenericAppConfigException
applicationID
- - The ID of the ApplicationApplication
vo. If the Application is found, then the Application
VO contains the application configuration. This API will return a null if the Application by the specified name is not found in the system.AuthorizationFailedException
- If the logged in user does not have authorization to get the application details.GenericAppConfigException
- Any other error while performing the search operation.java.util.List findApplication(SearchCriteria searchCriteria, java.util.HashMap configParams) throws AuthorizationFailedException, GenericAppConfigException
searchCriteria
- - The search criteria using which to perform search for the ApplicationApplication
VOs based on the results of the search operation. Application by the specified name is not found in the system.AuthorizationFailedException
- If the logged in user does not have authorization to get the application details.GenericAppConfigException
- Any other error while performing the search operation.java.util.List getSupportedApplicationObjectclasses(Application application) throws AuthorizationFailedException, ConnectorException
application
- - The Application
for which to find the supported objectclasses.ApplicationObjectclass
VOs having configuration of the objectclasses that are supported by the underlying connector bundleAuthorizationFailedException
- If the logged in user does not have authorization to perform the operation.ConnectorException
- Any other error while performing the search operation.java.util.List getConfiguredApplicationObjectclasses(java.lang.String applicationID) throws NoSuchEntityException, AuthorizationFailedException, ConnectorException
applicationID
- - The ID of the application for which to get the ApplicationObjectclassesApplicationObjectclass
VOs that have been configured for the specified ApplicationNoSuchEntityException
- If the Application with the specified ID does not exist in the system.AuthorizationFailedException
- If the logged in user does not have authorization to perform the operation.ConnectorException
- Any other error while performing the search operation.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |