oracle.iam.application.api

Interface ApplicationManager

public interface ApplicationManager

Method Summary

Modifier and Type	Method and Description
java.lang.String	addJob(java.lang.String applicationName, ApplicationJobDetails applicationJobDetails)
void	clone(java.lang.String applicationName) Clone application
void	compileScript(java.lang.String scriptText) This API method will validate compilation of given groovy script.
void	create(Application application) Create application
boolean	createBackup(Application app)
void	createInstanceFromApplication(Application application) Create instance from Application Newly created application will share the Schema,Provisioning and Reconciliation configurations.
void	createTemplate(Application application) Create a Template.
void	deleteApplicationJob(java.lang.String applicationName, java.lang.String jobName) Delete given schedule job and remove its entry from given template as well
void	disableJob(java.lang.String jobName)
void	enableJob(java.lang.String jobName)
java.util.List	findApplications(SearchCriteria searchCriteria, java.util.HashMap configParams) Returns the list of the Applications based on the search criteria published in user's organization scope and has VIEW_SEARCH privilege on application.
ApplicationDiff	findDiff(Application app)
java.util.List	findFlatFieConnectedApplications(SearchCriteria searchCriteria, java.util.HashMap configParams) Returns the list of the FlatFile Configurations for a Connected Application based on the search criteria published in user's organization scope and has VIEW_SEARCH privilege on application.
java.util.List	findTemplates(SearchCriteria searchCriteria) Returns a list of templates based on given search criteria which are saved as a template from UI or imported through Deployment Manager.
boolean	flushBackup(Application app)
java.util.List	getAllJobsForApplication(java.lang.String applicationName)
Application	getApplication(java.lang.String appName) Retrieves the application detail by name
ApplicationUIMetadata	getApplicationUIMetadata() Get UI related static metadata
java.util.List	getAvailableUpgrades()
java.util.List	getConnectorServers() Get the list of names of all the Connector Servers.
ApplicationJobDetails	getDetailsOfJob(java.lang.String applicationName, java.lang.String jobName)
java.util.List	getHeaders(java.lang.String fileLocation, Application app) To get list of headers of given CSV file This api will parse given csv file and return list of headers
java.util.List	getHistoryofJob(java.lang.String jobName)
ApplicationJobReport	getReportofJob(java.lang.Double historyId)
java.util.List	getResultsofJobHistory(java.lang.Double historyId)
Application	getTemplate(java.lang.String templateName) Get the Template based on given template name.
Application	getTemplateFromBundle(java.lang.String connectorName, java.lang.String connectorVersion, boolean isAuthoritative) Return java representation of XML based Application Template for the requested connector
Application	getTemplateFromBundle(java.lang.String connectorName, java.lang.String connectorVersion, java.lang.String connectorPkgPath, boolean isAuthoritative) Return java representation of XML based Application Template for the requested connector
java.util.List	getUpgradeStatus()
java.util.List	getUpgradeStatus(java.lang.String connectorName, java.lang.String connectorVersion)
java.util.List	listAvailableConnectors(boolean isAuthoritative) Returns the list of available Connector bundles reside in ConnectorDefaultDirectory based on isAuthoritative parameter value.
java.util.List	listAvailableConnectors(java.lang.String alternatePath, boolean isAuthoritative) Returns the list of available Connector bundles reside in alternate deployment Directory based on isAuthoritative parameter value.
Application	populateTargetSchema(Application application)
java.util.List	readSchemaAttributesFromBundle(Application application, java.lang.String objectClassName) Read schema attributes for the given Object Class from the connector bundle
void	retrySingleAppUpgrade(java.lang.String appName)
void	retryUpgrade(java.util.List diffs)
void	runJob(java.lang.String jobName)
void	stopJob(java.lang.String jobName)
void	testConnection(Application application) This API method will verify whether the application is able to connect to the actual target successfully.
void	update(Application application) Update application or instace application application will be considered as instance application if baseApplicationName is supplied.
void	updateJob(java.lang.String applicationName, ApplicationJobDetails applicationJobDetails)
void	updateTemplate(Application application) Update existing Template.
void	upgrade(java.util.List diffs)

Method Detail

findApplications

java.util.List findApplications(SearchCriteria searchCriteria,
                                java.util.HashMap configParams)
                         throws java.lang.Exception

Returns the list of the Applications based on the search criteria published in user's organization scope and has VIEW_SEARCH privilege on application.

Parameters:

searchCriteria - The Search criteria based on which Applications will be retrieved from the backend.

configParams - Parameter to further configure the search operation. You can provide name,displayName,connectorName,connectorVersion,disconnected,authoritative,SORTEDBY and SORTORDER as search parameter.

The 'name' search configuration parameter indicates application name.

The 'displayName' search configuration parameter indicates application display name.

The 'connectorName' search configuration parameter indicates Connector display name of the application.

The 'connectorVersion' search configuration parameter indicates Connector version of the application.

The 'disconnected' search configuration parameter indicates whether application is Disconnected on not. Pass 'true' to search for disconnected application only.

The 'authoritative' search configuration parameter indicates whether application is Authoritative on not

Pass 'true' to search for Authoritative application only. The 'name' search configuration parameter indicates name of the application instance

The 'name' search configuration parameter indicates name of the application instance

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional.

The SORTORDER configuration parameter indicates the sorting order of the result, SortOrder.ASCENDING and SortOrder.DESCENDING. This parameter is optional.

Returns:

list of Application VO that match the search criteria.

Throws:

java.lang.Exception

findFlatFieConnectedApplications

java.util.List findFlatFieConnectedApplications(SearchCriteria searchCriteria,
                                                java.util.HashMap configParams)
                                         throws java.lang.Exception

Returns the list of the FlatFile Configurations for a Connected Application based on the search criteria published in user's organization scope and has VIEW_SEARCH privilege on application.

Parameters:

searchCriteria - The Search criteria based on which Configurations will be retrieved from the backend.

configParams - Parameter to further configure the search operation. You can provide name,displayName,SORTEDBY and SORTORDER as search parameter.

The 'name' search configuration parameter indicates flatfile configuration name.

The 'displayName' search configuration parameter indicates flatfile configuration display name. *

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional.

The SORTORDER configuration parameter indicates the sorting order of the result, SortOrder.ASCENDING and SortOrder.DESCENDING. This parameter is optional.

Returns:

list of Application VO that match the search criteria.

Throws:

java.lang.Exception

testConnection

void testConnection(Application application)
             throws java.lang.Exception

This API method will verify whether the application is able to connect to the actual target successfully. This assumes that all the configuration propeties and the @oracle.iam.application.vo.Application is configured properly.

Parameters:

application - The Application VO for which to test the connection, with the configuration properties configured.

Throws:

java.lang.Exception

compileScript

void compileScript(java.lang.String scriptText)
            throws java.lang.Exception

This API method will validate compilation of given groovy script. Given groovy script can be validation or transformation script.

Parameters:

scriptText- - script source code as String

Throws:

java.lang.Exception - in case of compilation failure or exception in generating script class-

listAvailableConnectors

java.util.List listAvailableConnectors(java.lang.String alternatePath,
                                       boolean isAuthoritative)
                                throws java.lang.Exception

Returns the list of available Connector bundles reside in alternate deployment Directory based on isAuthoritative parameter value. if isAuthoritative paramerter is true then return list of connector bundle which has trusted template if isAuthoritative paramerter is false then return list of connector bundle which has target template

Parameters:

alternatePath - - absolute path of the alternate Directory

isAuthoritative - - this boolean flag indicates filter criteria among list of connectors deployed set 'true' to get list of connectors which has template for Authoritative source set 'false' to get a list of connectors which has template for Target Resource

Returns:

set of CIBean which contains the connector bundle package information. CIBean contains Connector Display Name,Connector Version CI XML file absolute path, Application Template absolute path. Connector bundle package absolute path.

Throws:

java.lang.Exception

listAvailableConnectors

java.util.List listAvailableConnectors(boolean isAuthoritative)
                                throws java.lang.Exception

Returns the list of available Connector bundles reside in ConnectorDefaultDirectory based on isAuthoritative parameter value. if isAuthoritative paramerter is true then return list of connector bundle which has trusted template if isAuthoritative paramerter is false then return list of connector bundle which has target template

Parameters:

isAuthoritative - - this boolean flag indicates filter criteria among list of connectors deployed set 'true' to get list of connectors which has template for Authoritative source set 'false' to get a list of connectors which has template for Target Resource

Returns:

Set of CIBean which contains the connector bundle package information. CIBean contains Connector Display Name,Connector Version CI XML file absolute path, Application Template absolute path. Connector bundle package absolute path.

Throws:

java.lang.Exception

clone

void clone(java.lang.String applicationName)
    throws java.lang.Exception

Clone application

Parameters:

applicationName - Name of application

Throws:

java.lang.Exception

create

void create(Application application)
     throws java.lang.Exception

Create application

Parameters:

applicationName - Name of application

Throws:

java.lang.Exception

update

void update(Application application)
     throws java.lang.Exception

Update application or instace application application will be considered as instance application if baseApplicationName is supplied. Only below attributes/configuration update is supported during instance application update. 1. Application Name 2. Application Display Name 3. Application Description 4. Basic Configurations 5. Catalog attributes 6. Organization publication Below additional configuration update is supported with application update 1. Advance Configurations 2. Schema Configurations 3. Provisioning Configuration

Parameters:

application - Application instance

Throws:

java.lang.Exception

getTemplate

Application getTemplate(java.lang.String templateName)
                 throws java.lang.Exception

Get the Template based on given template name. Returned Template can be associated with application instance

Parameters:

templateName - Name of the template

Returns:

Returns the Application object

Throws:

java.lang.Exception

findTemplates

java.util.List findTemplates(SearchCriteria searchCriteria)
                      throws java.lang.Exception

Returns a list of templates based on given search criteria which are saved as a template from UI or imported through Deployment Manager. Will not contain application in returned list

Parameters:

searchCriteria - Search criteria based on which Templates will be retrieved

Returns:

list of Application Objects

Throws:

java.lang.Exception

getTemplateFromBundle

Application getTemplateFromBundle(java.lang.String connectorName,
                                  java.lang.String connectorVersion,
                                  boolean isAuthoritative)
                           throws java.io.FileNotFoundException,
                                  java.lang.Exception

Return java representation of XML based Application Template for the requested connector

Parameters:

connectorName - - Display name of the connector

connectorVersion - - Display version of the connector

Returns:

Returns the Application object

Throws:

FileNotFoundException,Exception - A XML based Application template must be present inside the bundle package under xml folder

java.io.FileNotFoundException

java.lang.Exception

getTemplateFromBundle

Application getTemplateFromBundle(java.lang.String connectorName,
                                  java.lang.String connectorVersion,
                                  java.lang.String connectorPkgPath,
                                  boolean isAuthoritative)
                           throws java.io.FileNotFoundException,
                                  java.lang.Exception

Return java representation of XML based Application Template for the requested connector

Parameters:

connectorName - - Display name of the connector

connectorVersion - - Display version of the connector

connectorPkgPath - - Absolute path of the connector bundle package deployed into OIM

Returns:

Returns the Application object

Throws:

FileNotFoundException,Exception - A XML based Application template must be present inside the bundle package under xml folder

java.io.FileNotFoundException

java.lang.Exception

readSchemaAttributesFromBundle

java.util.List readSchemaAttributesFromBundle(Application application,
                                              java.lang.String objectClassName)
                                       throws java.lang.Exception

Read schema attributes for the given Object Class from the connector bundle

Parameters:

application - - Application Template instance

objectClassName - - Name of the target system Object class(__ACCOUNT__,__GROUP__ etc.)

Returns:

Returns list of SchemaAttributes. Returns empty list if object class is not supported by the connector bundle

Throws:

java.lang.Exception

updateTemplate

void updateTemplate(Application application)
             throws java.lang.Exception

Update existing Template. No application footprint will get created. The template will be updated for future use

Parameters:

application - - Application Template instance

Throws:

java.lang.Exception

createTemplate

void createTemplate(Application application)
             throws java.lang.Exception

Create a Template. No application footprint will get created. The template will be created for future use

Parameters:

application -

Throws:

java.lang.Exception

getApplication

Application getApplication(java.lang.String appName)
                    throws java.lang.Exception

Retrieves the application detail by name

Parameters:

appName - Name of the application instance

Returns:

Returns the Application object

Throws:

java.lang.Exception

getConnectorServers

java.util.List getConnectorServers()
                            throws java.lang.Exception

Get the list of names of all the Connector Servers.

Returns:

List of name of connector servers

Throws:

Exceptions

java.lang.Exception

getApplicationUIMetadata

ApplicationUIMetadata getApplicationUIMetadata()
                                        throws java.lang.Exception

Get UI related static metadata

Returns:

- ApplicationUIMetadata instance

Throws:

java.lang.Exception

createInstanceFromApplication

void createInstanceFromApplication(Application application)
                            throws java.lang.Exception

Create instance from Application Newly created application will share the Schema,Provisioning and Reconciliation configurations. Connectivity info(Basic Configurations) will be unique. baseApplicationName from Application VO will be used to create new application from existing application. Only below attributes/configuration will be used from supplied Application to create new application, other attribute will be used from base application 1. Application Name 2. Application Display Name 3. Application Description 4. Basic Configurations 5. Catalog attributes 6. Organization publication New application will use below Configurations from base application 1. Advance Configurations 2. Schema Configurations 3. Provisioning Configuration

Parameters:

application - Application vo with base application name

Throws:

java.lang.Exception - Exception will be thrown if 1. Application is not successfully validated against application.xsd 2. Application does not contains required parameter 3. Application Name is not unique 4. Application does not contains valid base application name.

getAllJobsForApplication

java.util.List getAllJobsForApplication(java.lang.String applicationName)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getDetailsOfJob

ApplicationJobDetails getDetailsOfJob(java.lang.String applicationName,
                                      java.lang.String jobName)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getHistoryofJob

java.util.List getHistoryofJob(java.lang.String jobName)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getResultsofJobHistory

java.util.List getResultsofJobHistory(java.lang.Double historyId)
                               throws java.lang.Exception

Throws:

java.lang.Exception

runJob

void runJob(java.lang.String jobName)
     throws java.lang.Exception

Throws:

java.lang.Exception

stopJob

void stopJob(java.lang.String jobName)
      throws java.lang.Exception

Throws:

java.lang.Exception

enableJob

void enableJob(java.lang.String jobName)
        throws java.lang.Exception

Throws:

java.lang.Exception

disableJob

void disableJob(java.lang.String jobName)
         throws java.lang.Exception

Throws:

java.lang.Exception

populateTargetSchema

Application populateTargetSchema(Application application)
                          throws java.lang.Exception

Throws:

java.lang.Exception

updateJob

void updateJob(java.lang.String applicationName,
               ApplicationJobDetails applicationJobDetails)
        throws java.lang.Exception

Throws:

java.lang.Exception

addJob

java.lang.String addJob(java.lang.String applicationName,
                        ApplicationJobDetails applicationJobDetails)
                 throws java.lang.Exception

Throws:

java.lang.Exception

getReportofJob

ApplicationJobReport getReportofJob(java.lang.Double historyId)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getHeaders

java.util.List getHeaders(java.lang.String fileLocation,
                          Application app)
                   throws java.lang.Exception

To get list of headers of given CSV file This api will parse given csv file and return list of headers

Parameters:

fileLocation - location csv file

Returns:

Throws:

java.lang.Exception

deleteApplicationJob

void deleteApplicationJob(java.lang.String applicationName,
                          java.lang.String jobName)
                   throws java.lang.Exception

Delete given schedule job and remove its entry from given template as well

Parameters:

applicationName - Application Name

jobName - Job Name

Throws:

java.lang.Exception

getAvailableUpgrades

java.util.List getAvailableUpgrades()
                             throws java.lang.Exception

Throws:

java.lang.Exception

findDiff

ApplicationDiff findDiff(Application app)
                  throws java.lang.Exception

Throws:

java.lang.Exception

createBackup

boolean createBackup(Application app)
              throws java.lang.Exception

Throws:

java.lang.Exception

flushBackup

boolean flushBackup(Application app)
             throws java.lang.Exception

Throws:

java.lang.Exception

upgrade

void upgrade(java.util.List diffs)
      throws java.lang.Exception

Throws:

java.lang.Exception

retrySingleAppUpgrade

void retrySingleAppUpgrade(java.lang.String appName)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getUpgradeStatus

java.util.List getUpgradeStatus(java.lang.String connectorName,
                                java.lang.String connectorVersion)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getUpgradeStatus

java.util.List getUpgradeStatus()
                         throws java.lang.Exception

Throws:

java.lang.Exception

retryUpgrade

void retryUpgrade(java.util.List diffs)
           throws java.lang.Exception

Throws:

java.lang.Exception