oracle.iam.provisioning.api

Interface ApplicationService

public interface ApplicationService

Method Summary

Modifier and Type	Method and Description
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

create

Application create(Application application)
            throws DuplicateApplicationException,
                   AuthorizationFailedException,
                   GenericAppConfigException

This API service method creates a new Application in the system

Parameters:

application - - The Application value object that contains configuration of the Application to be created.

Returns:

An OperationResult vo. If the Application is successfully created, then the OperationResult Vo contains the entityID of the Application.

Throws:

DuplicateApplicationException - If an Application by the name already exists in the system

AuthorizationFailedException - If any authorization error occurs while creating the Application

GenericAppConfigException - Any other error while persisting the Application configuration in the system.

Since:

11.1.2.3.0

create

OperationResult create(Application application,
                       java.util.List appObjectclasses)
                throws DuplicateApplicationException,
                       DuplicateApplicationObjectclassException,
                       AuthorizationFailedException,
                       GenericAppConfigException

This API service method creates a new Application with its objectclasses in the system.

Parameters:

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.

Returns:

An 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.

Throws:

DuplicateApplicationException - If an Application by the name already exists in the system

DuplicateApplicationObjectclassException - If an Application Objectclass having the same name as any one of the Application Objectclasses to be created already exists in the system

AuthorizationFailedException - If any authorization error occurs while creating the Application

GenericAppConfigException - Any other error while persisting the Application configuration in the system.

Since:

11.1.2.3.0

modify

Application modify(Application application)
            throws NoSuchEntityException,
                   AuthorizationFailedException,
                   GenericAppConfigException

This API service method modifies the configuration of an Application already present in the system

Parameters:

application - - The Application value object that holds the new configuration of the Application to be modified.

Returns:

An OperationResult vo. If the Application is successfully modified, then the OperationResult Vo contains the entityID of the Application and the appropriate status code.

Throws:

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.

Since:

11.1.2.3.0

modify

OperationResult modify(Application application,
                       java.util.List appObjectclasses)
                throws NoSuchEntityException,
                       AuthorizationFailedException,
                       GenericAppConfigException

This API service method modifies the configuration of an Application and its objectclasses that already exist in the system

Parameters:

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.

Returns:

An 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.

Throws:

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.

Since:

11.1.2.3.0

activate

boolean activate(java.lang.String applicationID)
          throws NoSuchEntityException,
                 AuthorizationFailedException,
                 GenericAppConfigException

This API service method activates an application in the system

Parameters:

applicationID - - The Application ID of the Application to be activated.

Returns:

A boolean indicating if the Application was activated or not. If the Application was already active, then this API will return false, else if the Application was successfully activated, then this API will return true.

Throws:

NoSuchEntityException - If the Application to be activated does not exist in the system.

AuthorizationFailedException - If any authorization error occurs while activating the Application

GenericAppConfigException - Any other error while activating the Application in the system.

Since:

11.1.2.3.0

deactivate

boolean deactivate(java.lang.String applicationID)
            throws NoSuchEntityException,
                   AuthorizationFailedException,
                   GenericAppConfigException

This API service method deactivates an application in the system

Parameters:

applicationID - - The Application ID of the Application to be deactivated.

Returns:

A boolean indicating if the Application was deactivated or not. If the Application was already disabled, then this API will return false, else if the Application was successfully deactivated, then this API will return true.

Throws:

NoSuchEntityException - If the Application to be deactivated does not exist in the system.

AuthorizationFailedException - If any authorization error occurs while deactivating the Application

GenericAppConfigException - Any other error while deactivating the Application in the system.

Since:

11.1.2.3.0

delete

boolean delete(java.lang.String applicationID)
        throws NoSuchEntityException,
               AuthorizationFailedException,
               GenericAppConfigException

This API service method soft-deletes an application in the system. Post-processing of the soft-deletion, including physical deletion of the Application and associated objects will be performed in an offlined manner

Parameters:

applicationID - - The Application ID of the Application to be deleted.

Returns:

A boolean indicating if the Application was deleted or not. If the Application was already deleted, then this API will return false, else if the Application was successfully deleted, then this API will return true.

Throws:

NoSuchEntityException - If the Application to be deleted does not exist in the system.

AuthorizationFailedException - If any authorization error occurs while deleted the Application

GenericAppConfigException - Any other error while deleted the Application in the system.

Since:

11.1.2.3.0

testConnection

void testConnection(java.lang.String applicationID)
             throws NoSuchEntityException,
                    AuthorizationFailedException,
                    ConnectorException

This API service method will check whether the connection to the actual target can be successfully performed or not. This API assumes that the Application and all the connector bundle properties are properly configured.

Parameters:

applicationID - - The Application ID of the Application for which to perform test the connectivity.

Throws:

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 Application

ConnectorException - If any error occurs while performing test connection, either from ICF, the connector bundle, or the actual target itself.

findApplicationByName

Application findApplicationByName(java.lang.String applicationName)
                           throws AuthorizationFailedException,
                                  GenericAppConfigException

This API service method provides a mechanism of getting an Application details by name.

Parameters:

applicationName - - The name of the Application

Returns:

An Application 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.

Throws:

AuthorizationFailedException - If the logged in user does not have authorization to get the application details.

GenericAppConfigException - Any other error while performing the search operation.

Since:

11.1.2.3.0

findApplicationByID

Application findApplicationByID(java.lang.String applicationID)
                         throws AuthorizationFailedException,
                                GenericAppConfigException

This API service method provides a mechanism of getting an Application details by ID.

Parameters:

applicationID - - The ID of the Application

Returns:

An Application 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.

Throws:

AuthorizationFailedException - If the logged in user does not have authorization to get the application details.

GenericAppConfigException - Any other error while performing the search operation.

Since:

11.1.2.3.0

findApplication

java.util.List findApplication(SearchCriteria searchCriteria,
                               java.util.HashMap configParams)
                        throws AuthorizationFailedException,
                               GenericAppConfigException

This API service method provides a mechanism of getting an Application details by specifying a search criteria.

Parameters:

searchCriteria - - The search criteria using which to perform search for the Application

Returns:

A list of Application VOs based on the results of the search operation. Application by the specified name is not found in the system.

Throws:

AuthorizationFailedException - If the logged in user does not have authorization to get the application details.

GenericAppConfigException - Any other error while performing the search operation.

Since:

11.1.2.3.0

getSupportedApplicationObjectclasses

java.util.List getSupportedApplicationObjectclasses(Application application)
                                             throws AuthorizationFailedException,
                                                    ConnectorException

This API service method returns a list of all the ApplicationObjectclasses supported by the Application. This API is invoked by the UI when the Application is not yet created. The API will get all the objectclasses that are supported by the connector bundle that this Application references, and return a list of ApplicationObjectclass VOs embedding their configuration. Please note that the VOs will be partially populated since the Application and the ApplicationObjectclasses are not yet created in the system.

Parameters:

application - - The Application for which to find the supported objectclasses.

Returns:

A list of ApplicationObjectclass VOs having configuration of the objectclasses that are supported by the underlying connector bundle

Throws:

AuthorizationFailedException - If the logged in user does not have authorization to perform the operation.

ConnectorException - Any other error while performing the search operation.

Since:

11.1.2.3.0

getConfiguredApplicationObjectclasses

java.util.List getConfiguredApplicationObjectclasses(java.lang.String applicationID)
                                              throws NoSuchEntityException,
                                                     AuthorizationFailedException,
                                                     ConnectorException

This API service method returns a list of all the ApplicationObjectclasses configured for a specific Application. The configuration returned by this API will be for entities that are already created in the system.

Parameters:

applicationID - - The ID of the application for which to get the ApplicationObjectclasses

Returns:

A list of ApplicationObjectclass VOs that have been configured for the specified Application

Throws:

NoSuchEntityException - 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.

Since:

11.1.2.3.0