Skip navigation links

oracle.security.jps.service.policystore.entitymanager
Interface ConfigurationManager

All Superinterfaces:

EntityManager

public interface ConfigurationManager

extends EntityManager

Configuration Manager interface is used to manage OES configuration such as OES Security Modules, OES Custom PIP.

Method Summary

SMEntry	createSecurityModule(java.lang.String smName, java.lang.String displayName, java.lang.String description) Create an OES SM Configuration.
void	deleteSecurityModule(java.lang.String smName) Delete configuration for a given SM.
SMEntry	getSecurityModule(java.lang.String smName) Get Instance of SM Configuration, by SM Name.
java.util.List<SMEntry>	getSecurityModules(SecurityModuleSearchQuery query) Get a set of SM entries base on search pattern
void	modifySecurityModule(SMEntry config) Update a SM.

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

resolveReference

Method Detail

createSecurityModule

SMEntry createSecurityModule(java.lang.String smName,
                             java.lang.String displayName,
                             java.lang.String description)
                             throws ConfigurationAlreadyExistsException,
                                    InvalidArgumentException,
                                    PolicyStoreException

Create an OES SM Configuration.

Parameters:

smName - - Name of a Security module configuration

displayName - - display name to be used for SM, null to use same as smName

description - - Description as required, null if none

Returns:

SMEntry to the newly created configuration

Throws:

ConfigurationAlreadyExistsException - - if Security module with the name already exists

InvalidArgumentException - - on invalid parameter

PolicyStoreException - - check message for specific policy store issue

deleteSecurityModule

void deleteSecurityModule(java.lang.String smName)
                          throws ConfigurationNotFoundException,
                                 InvalidArgumentException,
                                 PolicyStoreException

Delete configuration for a given SM. Note that this is a cascade delete. Delete of a SM deletes all its providers and its configuration.

Parameters:

smName - - the SM Name to be deleted

Throws:

ConfigurationNotFoundException - ??? if Configuration does not exist

InvalidArgumentException - - if invalid parameter

PolicyStoreException - - check message for specific policy store issue

getSecurityModule

SMEntry getSecurityModule(java.lang.String smName)
                          throws InvalidArgumentException,
                                 ConfigurationNotFoundException,
                                 PolicyStoreException

Get Instance of SM Configuration, by SM Name.

Parameters:

smConfigurationId - - contains the unique ID

Returns:

ConfigurationEntry of type SMEntry if available

Throws:

InvalidArgumentException - - if invalid parameter

ConfigurationNotFoundException - - if the specified security module does not exist

PolicyStoreException - - check message for specific policy store issue

getSecurityModules

java.util.List<SMEntry> getSecurityModules(SecurityModuleSearchQuery query)
                                           throws PolicyStoreException,
                                                  InvalidArgumentException

Get a set of SM entries base on search pattern

Parameters:

query - - instance of configuration search query pattern

Returns:

SMEntry instances if available; empty list otherwise

Throws:

InvalidArgumentException - - on invalid parameter.

PolicyStoreException - - check message for specific policy store issue

modifySecurityModule

void modifySecurityModule(SMEntry config)
                          throws ConfigurationNotFoundException,
                                 PolicyStoreException,
                                 InvalidArgumentException

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

Parameters:

config - - SM Configuration to be updated

Throws:

ConfigurationNotFoundException - ??? if Configuration does not exist

InvalidArgumentException - - on invalid parameter.

PolicyStoreException - - check message for specific policy store issue

Skip navigation links