public interface ApplicationManager
Modifier and Type | Method and Description |
---|---|
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
|
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.
|
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.
|
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.
|
Application |
getApplication(java.lang.String appName)
Retrieves the application detail by name
|
ApplicationUIMetadata |
getApplicationUIMetadata()
Get UI related static metadata
|
java.util.List |
getConnectorServers()
Get the list of names of all the Connector Servers.
|
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 |
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.
|
java.util.List |
readSchemaAttributesFromBundle(Application application,
java.lang.String objectClassName)
Read schema attributes for the given Object Class from the connector bundle
|
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 |
updateTemplate(Application application)
Update existing Template.
|
java.util.List findApplications(SearchCriteria searchCriteria, java.util.HashMap configParams) throws java.lang.Exception
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.
java.lang.Exception
void testConnection(Application application) throws java.lang.Exception
application
- The Application VO for which to test the connection,
with the configuration properties configured.java.lang.Exception
void compileScript(java.lang.String scriptText) throws java.lang.Exception
scriptText-
- script source code as Stringjava.lang.Exception
- in case of compilation failure or exception in generating script class-java.util.List listAvailableConnectors(java.lang.String alternatePath, boolean isAuthoritative) throws java.lang.Exception
alternatePath
- - absolute path of the alternate DirectoryisAuthoritative
- - 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 Resourcejava.lang.Exception
java.util.List listAvailableConnectors(boolean isAuthoritative) throws java.lang.Exception
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 Resourcejava.lang.Exception
void clone(java.lang.String applicationName) throws java.lang.Exception
applicationName
- Name of applicationjava.lang.Exception
void create(Application application) throws java.lang.Exception
applicationName
- Name of applicationjava.lang.Exception
void update(Application application) throws java.lang.Exception
application
- Application instancejava.lang.Exception
Application getTemplate(java.lang.String templateName) throws java.lang.Exception
templateName
- Name of the templatejava.lang.Exception
java.util.List findTemplates(SearchCriteria searchCriteria) throws java.lang.Exception
searchCriteria
- Search criteria based on which Templates will be retrievedjava.lang.Exception
Application getTemplateFromBundle(java.lang.String connectorName, java.lang.String connectorVersion, boolean isAuthoritative) throws java.io.FileNotFoundException, java.lang.Exception
connectorName
- - Display name of the connectorconnectorVersion
- - Display version of the connectorFileNotFoundException,Exception
- A XML based Application template must be present inside the bundle package under xml folderjava.io.FileNotFoundException
java.lang.Exception
Application getTemplateFromBundle(java.lang.String connectorName, java.lang.String connectorVersion, java.lang.String connectorPkgPath, boolean isAuthoritative) throws java.io.FileNotFoundException, java.lang.Exception
connectorName
- - Display name of the connectorconnectorVersion
- - Display version of the connectorconnectorPkgPath
- - Absolute path of the connector bundle package deployed into OIMFileNotFoundException,Exception
- A XML based Application template must be present inside the bundle package under xml folderjava.io.FileNotFoundException
java.lang.Exception
java.util.List readSchemaAttributesFromBundle(Application application, java.lang.String objectClassName) throws java.lang.Exception
application
- - Application Template instanceobjectClassName
- - Name of the target system Object class(__ACCOUNT__,__GROUP__ etc.)java.lang.Exception
void updateTemplate(Application application) throws java.lang.Exception
application
- - Application Template instancejava.lang.Exception
void createTemplate(Application application) throws java.lang.Exception
application
- java.lang.Exception
Application getApplication(java.lang.String appName) throws java.lang.Exception
appName
- Name of the application instancejava.lang.Exception
java.util.List getConnectorServers() throws java.lang.Exception
Exceptions
java.lang.Exception
ApplicationUIMetadata getApplicationUIMetadata() throws java.lang.Exception
java.lang.Exception
void createInstanceFromApplication(Application application) throws java.lang.Exception
application
- Application vo with base application namejava.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.