Package oracle.iam.application.api

Interface ApplicationManager

public interface ApplicationManager

Method Summary

Modifier and Type	Method	Description
String	addJob(String applicationName, ApplicationJobDetails applicationJobDetails)
void	clone(String applicationName)	Clone application
void	compileScript(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(String applicationName, String jobName)	Delete given schedule job and remove its entry from given template as well
void	disableJob(String jobName)
void	enableJob(String jobName)
List<Application>	findApplications(SearchCriteria searchCriteria, HashMap<String,Object> 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)
List<Application>	findFlatFieConnectedApplications(SearchCriteria searchCriteria, HashMap<String,Object> 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.
List<Application>	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)
List<ReconJobDetail>	getAllJobsForApplication(String applicationName)
Application	getApplication(String appName)	Retrieves the application detail by name
ApplicationUIMetadata	getApplicationUIMetadata()	Get UI related static metadata
List<String>	getAvailableUpgrades()
List<String>	getConnectorServers()	Get the list of names of all the Connector Servers.
ApplicationJobDetails	getDetailsOfJob(String applicationName, String jobName)
List<String>	getHeaders(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
List<ApplicationJobHistory>	getHistoryofJob(String jobName)
ApplicationJobReport	getReportofJob(Double historyId)
List<ApplicationJobResult>	getResultsofJobHistory(Double historyId)
Application	getTemplate(String templateName)	Get the Template based on given template name.
Application	getTemplateFromBundle(String connectorName, String connectorVersion, boolean isAuthoritative)	Return java representation of XML based Application Template for the requested connector
Application	getTemplateFromBundle(String connectorName, String connectorVersion, String connectorPkgPath, boolean isAuthoritative)	Return java representation of XML based Application Template for the requested connector
List<ConnectorUpgrade>	getUpgradeStatus()
List<AppUpgrade>	getUpgradeStatus(String connectorName, String connectorVersion)
List<CIBean>	listAvailableConnectors(boolean isAuthoritative)	Returns the list of available Connector bundles reside in ConnectorDefaultDirectory based on isAuthoritative parameter value.
List<CIBean>	listAvailableConnectors(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)
List<SchemaAttribute>	readSchemaAttributesFromBundle(Application application, String objectClassName)	Read schema attributes for the given Object Class from the connector bundle
void	retrySingleAppUpgrade(String appName)
void	retryUpgrade(List<ApplicationDiff> diffs)
void	runJob(String jobName)
void	stopJob(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(String applicationName, ApplicationJobDetails applicationJobDetails)
void	updateTemplate(Application application)	Update existing Template.
void	upgrade(List<ApplicationDiff> diffs)

Method Details

findApplications

List<Application> findApplications(SearchCriteria searchCriteria,
 HashMap<String,Object> configParams)
                            throws 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:

Exception

findFlatFieConnectedApplications

List<Application> findFlatFieConnectedApplications(SearchCriteria searchCriteria,
 HashMap<String,Object> configParams)
                                            throws 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:

Exception

testConnection

void testConnection(Application application)
             throws 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:

Exception

compileScript

void compileScript(String scriptText)
            throws 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:

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

listAvailableConnectors

List<CIBean> listAvailableConnectors(String alternatePath,
 boolean isAuthoritative)
                              throws 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:

Exception

listAvailableConnectors

List<CIBean> listAvailableConnectors(boolean isAuthoritative)
                              throws 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:

Exception

clone

void clone(String applicationName)
    throws Exception

Clone application

Parameters:

applicationName - Name of application

Throws:

Exception

create

void create(Application application)
     throws Exception

Create application

Parameters:

applicationName - Name of application

Throws:

Exception

update

void update(Application application)
     throws 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:

Exception

getTemplate

Application getTemplate(String templateName)
                 throws 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:

Exception

findTemplates

List<Application> findTemplates(SearchCriteria searchCriteria)
                         throws 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:

Exception

getTemplateFromBundle

Application getTemplateFromBundle(String connectorName,
 String connectorVersion,
 boolean isAuthoritative)
                           throws FileNotFoundException,
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

getTemplateFromBundle

Application getTemplateFromBundle(String connectorName,
 String connectorVersion,
 String connectorPkgPath,
 boolean isAuthoritative)
                           throws FileNotFoundException,
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

readSchemaAttributesFromBundle

List<SchemaAttribute> readSchemaAttributesFromBundle(Application application,
 String objectClassName)
                                              throws 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:

Exception

updateTemplate

void updateTemplate(Application application)
             throws Exception

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

Parameters:

application - - Application Template instance

Throws:

Exception

createTemplate

void createTemplate(Application application)
             throws Exception

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

Parameters:

application -

Throws:

Exception

getApplication

Application getApplication(String appName)
                    throws Exception

Retrieves the application detail by name

Parameters:

appName - Name of the application instance

Returns:

Returns the Application object

Throws:

Exception

getConnectorServers

List<String> getConnectorServers()
                          throws Exception

Get the list of names of all the Connector Servers.

Returns:

List of name of connector servers

Throws:

Exceptions

Exception

getApplicationUIMetadata

ApplicationUIMetadata getApplicationUIMetadata()
                                        throws Exception

Get UI related static metadata

Returns:

- ApplicationUIMetadata instance

Throws:

Exception

createInstanceFromApplication

void createInstanceFromApplication(Application application)
                            throws 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:

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

List<ReconJobDetail> getAllJobsForApplication(String applicationName)
                                       throws Exception

Throws:

Exception

getDetailsOfJob

ApplicationJobDetails getDetailsOfJob(String applicationName,
 String jobName)
                               throws Exception

Throws:

Exception

getHistoryofJob

List<ApplicationJobHistory> getHistoryofJob(String jobName)
                                     throws Exception

Throws:

Exception

getResultsofJobHistory

List<ApplicationJobResult> getResultsofJobHistory(Double historyId)
                                           throws Exception

Throws:

Exception

runJob

void runJob(String jobName)
     throws Exception

Throws:

Exception

stopJob

void stopJob(String jobName)
      throws Exception

Throws:

Exception

enableJob

void enableJob(String jobName)
        throws Exception

Throws:

Exception

disableJob

void disableJob(String jobName)
         throws Exception

Throws:

Exception

populateTargetSchema

Application populateTargetSchema(Application application)
                          throws Exception

Throws:

Exception

updateJob

void updateJob(String applicationName,
 ApplicationJobDetails applicationJobDetails)
        throws Exception

Throws:

Exception

addJob

String addJob(String applicationName,
 ApplicationJobDetails applicationJobDetails)
       throws Exception

Throws:

Exception

getReportofJob

ApplicationJobReport getReportofJob(Double historyId)
                             throws Exception

Throws:

Exception

getHeaders

List<String> getHeaders(String fileLocation,
 Application app)
                 throws 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:

Exception

deleteApplicationJob

void deleteApplicationJob(String applicationName,
 String jobName)
                   throws Exception

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

Parameters:

applicationName - Application Name

jobName - Job Name

Throws:

Exception

getAvailableUpgrades

List<String> getAvailableUpgrades()
                           throws Exception

Throws:

Exception

findDiff

ApplicationDiff findDiff(Application app)
                  throws Exception

Throws:

Exception

createBackup

boolean createBackup(Application app)
              throws Exception

Throws:

Exception

flushBackup

boolean flushBackup(Application app)
             throws Exception

Throws:

Exception

upgrade

void upgrade(List<ApplicationDiff> diffs)
      throws Exception

Throws:

Exception

retrySingleAppUpgrade

void retrySingleAppUpgrade(String appName)
                    throws Exception

Throws:

Exception

getUpgradeStatus

List<AppUpgrade> getUpgradeStatus(String connectorName,
 String connectorVersion)
                           throws Exception

Throws:

Exception

getUpgradeStatus

List<ConnectorUpgrade> getUpgradeStatus()
                                 throws Exception

Throws:

Exception

retryUpgrade

void retryUpgrade(List<ApplicationDiff> diffs)
           throws Exception

Throws:

Exception