Package oracle.iam.provisioning.api
Interface ConnectorServerService
public interface ConnectorServerService
-
Method Summary
Modifier and TypeMethodDescriptionCreates instance of connector server.void
Deletes ConnectorServer instance Note: ConnectorServer can only be deleted if it has no connectors deployed on itReturns all connector servers configuredReturns list of applications referencing connector bundles deployed on this connector serverRefresh cache with list of connectors deployed on a connectorserver.search
(SearchCriteria crit, HashMap<String, Object> configParams) searchByID
(String id) searchByName
(String name) void
Validate connection to the connector server
-
Method Details
-
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
-
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
Validate connection to the connector server- Parameters:
cs
- - ConnectorServer instance- Throws:
GenericAppConfigException
-
getAllConnectorServers
List<ConnectorServer> getAllConnectorServers() throws GenericAppConfigException, AuthorizationFailedExceptionReturns all connector servers configured- Returns:
- - List of ConnectorServer instances
- Throws:
GenericAppConfigException
AuthorizationFailedException
-
searchByName
List<ConnectorServer> searchByName(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(String id) throws GenericAppConfigException, AuthorizationFailedException - Parameters:
name
- - Connector Server ID- Returns:
- - Connector Server instance
- Throws:
GenericAppConfigException
AuthorizationFailedException
-
search
List<ConnectorServer> search(SearchCriteria crit, HashMap<String, Object> configParams) throws GenericAppConfigException, AuthorizationFailedException- Parameters:
crit
- - Search crtieria can be ConnectorServer.ATTRIBUTE.NAME, ConnectorServer.ATTRIBUTE.ID, ConnectorServer.ATTRIBUTE.HOSTconfigParams
- -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
List<ConnectorInfo> 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
List<Application> 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
-