oracle.security.jps.service.policystore.entitymanager.ras

Interface RASConfigurationManager

All Superinterfaces:

EntityManager

public interface RASConfigurationManager
extends EntityManager

RAS Configuration Manager interface is used to manage the configuration of RAS target database.

Method Summary

Methods

Modifier and Type	Method and Description
RASTargetDatabaseEntry	createTargetDatabase(java.lang.String targetDatabaseName, java.lang.String displayName, java.lang.String description, java.lang.String address, java.util.Properties connectionProperties, java.lang.String schema) Create a configuration for RAS target database.
void	deleteTargetDatabase(java.lang.String targetDatabaseName) Delete configuration for a given RAS target database.
RASTargetDatabaseEntry	getTargetDatabase(java.lang.String targetDatabaseName) Get Instance of target database Configuration, by target database Name.
java.util.List<RASTargetDatabaseEntry>	getTargetDatabases(RASTargetDatabaseSearchQuery query) Get a set of RASTargetDatabase entries base on search pattern
void	modifyTargetDatabase(RASTargetDatabaseEntry config) Update a target database configuration.

Methods inherited from interface oracle.security.jps.service.policystore.entitymanager.EntityManager

resolveReference

Method Detail

createTargetDatabase

RASTargetDatabaseEntry createTargetDatabase(java.lang.String targetDatabaseName,
                                          java.lang.String displayName,
                                          java.lang.String description,
                                          java.lang.String address,
                                          java.util.Properties connectionProperties,
                                          java.lang.String schema)
                                            throws InvalidArgumentException,
                                                   PolicyStoreException

Create a configuration for RAS target database.

Parameters:

targetDatabaseName - - Name of a target database configuration

displayName - - display name to be used for target database, null to use same as targetDatabaseName

description - - Description as required, null if none

address - - it could be the JNDI name of data source or JDBC URL which is used to connect to target database

connectionProperties - - properties which is used in connecting to target database using jdbc url.

schema - - the schema into which RAS policies to be written. If not specified the user which is used to connect to RAS DB is used as default schema.

Returns:

RASTargetDatabaseEntry for the newly created configuration

Throws:

ConfigurationAlreadyExistsException - - if target database with the name already exists

InvalidArgumentException - - on invalid parameter

PolicyStoreException - - check message for specific policy store issue

deleteTargetDatabase

void deleteTargetDatabase(java.lang.String targetDatabaseName)
                          throws InvalidArgumentException,
                                 PolicyStoreException

Delete configuration for a given RAS target database.

Parameters:

targetDatabaseName - - the target database Name to be deleted

Throws:

ConfigurationNotFoundException - if Configuration does not exist

InvalidArgumentException - - if invalid parameter

PolicyStoreException - - check message for specific policy store issue

getTargetDatabase

RASTargetDatabaseEntry getTargetDatabase(java.lang.String targetDatabaseName)
                                         throws InvalidArgumentException,
                                                PolicyStoreException

Get Instance of target database Configuration, by target database Name.

Parameters:

smConfigurationId - - contains the unique ID

Returns:

RASTargetDatabaseEntry for target database if available

Throws:

InvalidArgumentException - - if invalid parameter

ConfigurationNotFoundException - - if the specified target database does not exist

PolicyStoreException - - check message for specific policy store issue

getTargetDatabases

java.util.List<RASTargetDatabaseEntry> getTargetDatabases(RASTargetDatabaseSearchQuery query)
                                                          throws PolicyStoreException,
                                                                 InvalidArgumentException

Get a set of RASTargetDatabase entries base on search pattern

Parameters:

query - - instance of configuration search query pattern

Returns:

RASTargetDatabaseEntry instances if available; empty list otherwise

Throws:

InvalidArgumentException - - on invalid parameter.

PolicyStoreException - - check message for specific policy store issue

modifyTargetDatabase

void modifyTargetDatabase(RASTargetDatabaseEntry config)
                          throws PolicyStoreException,
                                 InvalidArgumentException

Update a target database configuration. Note that the parameters such as name, config_id etc cannot be updated. To update name, delete configuration first and recreate.

Parameters:

config - - target database Configuration to be updated

Throws:

ConfigurationNotFoundException - if Configuration does not exist

InvalidArgumentException - - on invalid parameter.

PolicyStoreException - - check message for specific policy store issue