oracle.iam.provisioning.api

Interface ConnectorServerService

public interface ConnectorServerService

Method Summary

Modifier and Type	Method and Description
ConnectorServer	create(ConnectorServer cs) Creates instance of connector server.
void	delete(ConnectorServer cs) Deletes ConnectorServer instance Note: ConnectorServer can only be deleted if it has no connectors deployed on it
java.util.List	getAllConnectorServers() Returns all connector servers configured
java.util.List	getApplicationsConfigured(ConnectorServer cs) Returns list of applications referencing connector bundles deployed on this connector server
java.util.List	getConnectorsDeployed(ConnectorServer cs) Refresh cache with list of connectors deployed on a connectorserver.
java.util.List	search(SearchCriteria crit, java.util.HashMap configParams)
ConnectorServer	searchByID(java.lang.String id)
java.util.List	searchByName(java.lang.String name)
void	testConnection(ConnectorServer cs) Validate connection to the connector server
ConnectorServer	update(ConnectorServer cs)

Method Detail

create

ConnectorServer create(ConnectorServer cs)
                throws GenericAppConfigException,
                       DuplicateConnectorServerException,
                       AuthorizationFailedException

Creates instance of connector server. Mandatory connector server fields are name, host, port, connection key. Cannot specify alive, id fields.

Parameters:

cs - -ConnectorServer instance

Returns:

Created instance of ConnectorServer

Throws:

DuplicateConnectorServerException

AuthorizationFailedException

GenericAppConfigException

update

ConnectorServer update(ConnectorServer cs)
                throws GenericAppConfigException,
                       ConnectorServerNotFoundException,
                       AuthorizationFailedException

Throws:

GenericAppConfigException

ConnectorServerNotFoundException

AuthorizationFailedException

delete

void delete(ConnectorServer cs)
     throws GenericAppConfigException,
            ConnectorServerNotFoundException,
            AuthorizationFailedException

Deletes ConnectorServer instance Note: ConnectorServer can only be deleted if it has no connectors deployed on it

Parameters:

ConnectorServer - instance with atleast the id field populated

Throws:

AuthorizationFailedException

ConnectorServerNotFoundException

GenericAppConfigException

testConnection

void testConnection(ConnectorServer cs)
             throws GenericAppConfigException

Validate connection to the connector server

Parameters:

cs - - ConnectorServer instance

Throws:

GenericAppConfigException

getAllConnectorServers

java.util.List getAllConnectorServers()
                               throws GenericAppConfigException,
                                      AuthorizationFailedException

Returns all connector servers configured

Returns:

- List of ConnectorServer instances

Throws:

GenericAppConfigException

AuthorizationFailedException

searchByName

java.util.List searchByName(java.lang.String name)
                     throws GenericAppConfigException,
                            AuthorizationFailedException

Parameters:

name - - Connector Server Name

Returns:

- list of connector server instances with specified name.

Throws:

GenericAppConfigException

AuthorizationFailedException

searchByID

ConnectorServer searchByID(java.lang.String id)
                    throws GenericAppConfigException,
                           AuthorizationFailedException

Parameters:

name - - Connector Server ID

Returns:

- Connector Server instance

Throws:

GenericAppConfigException

AuthorizationFailedException

search

java.util.List search(SearchCriteria crit,
                      java.util.HashMap configParams)
               throws GenericAppConfigException,
                      AuthorizationFailedException

Parameters:

crit - - Search crtieria can be ConnectorServer.ATTRIBUTE.NAME, ConnectorServer.ATTRIBUTE.ID, ConnectorServer.ATTRIBUTE.HOST

configParams - -Parameters to further configure the search operation. There are four configuration parameters. ProvisioningConstants.STARTROW, ENDROW, SORTEDBY and SORTORDER.

Returns:

list of ConnectorServer instances

Throws:

GenericAppConfigException

AuthorizationFailedException

getConnectorsDeployed

java.util.List getConnectorsDeployed(ConnectorServer cs)
                              throws GenericAppConfigException,
                                     AuthorizationFailedException

Refresh cache with list of connectors deployed on a connectorserver.

Parameters:

cs - - ConnectorServer - containing id

Returns:

list of connectors (including the reference to Bundle ConfigurationProperties)

Throws:

GenericAppConfigException

AuthorizationFailedException

getApplicationsConfigured

java.util.List getApplicationsConfigured(ConnectorServer cs)
                                  throws GenericAppConfigException,
                                         AuthorizationFailedException

Returns list of applications referencing connector bundles deployed on this connector server

Parameters:

cs - - ConnectorServer - containing id

Returns:

list of applications (including the reference to Bundle ConfigurationProperties)

Throws:

GenericAppConfigException

AuthorizationFailedException