Package oracle.iam.certification.api

Interface CertificationAdministrationService

public interface CertificationAdministrationService

Public administration API for the OIM Certification feature.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIGURATION_KEY_CERTIFICATION
static final String	CONFIGURATION_KEY_RISK_MAPPING

Method Summary

Modifier and Type	Method	Description
boolean	createCertificationJob(String certificationDefinitionName, String jobName, Trigger trigger)	Creates and schedules a job to run a certification for a given definition
EventListener	createEventListener(EventListener listener)	Creates an event listener
void	deleteCertificationDefinition(Long certificationDefinitionId)	Deletes a certification definition
void	deleteEventListener(String listenerName)	Deletes an event listener
List<EventListener>	findAllActiveEventListeners()	Retrieves all event listeners where status is EventListener.STATUS_ENABLED
List<EventListener>	findAllEventListeners()	Deprecated.
List<EventListener>	findAllEventListeners(SearchCriteria searchCriteria, Set retAttrs, HashMap configParams)	Retrieves all event listeners
List<CertificationDefinition>	findCertificationDefinitions(SearchCriteria searchCriteria, Set<String> retAttrs, Map<String,Object> configParams)	Retrieves all configured certification definitions, constrained by a PaginationContext provided in the configParams where default pagination context parameters are used when not included in the configParams or when configParams is null.
List<CertificationDefinition>	findCertificationDefinitionsByType(Integer certType, Set<String> retAttrs, Map<String,Object> configParams)	Retrieves all certification definitions of a given type
Map<String,oracle.soa.management.facade.Composite>	findComposites(String searchExpression)
List<String>	findCustomAccessReviewerMapName(String mapName)	Retrieves all CustomAccessReviewer map names
List<Map<String,String>>	findCustomReviewerMethods(Integer certType)	Retrieves all CustomReviewer methods for given certification type
Map<String,oracle.soa.management.facade.Composite>	findDefaultComposites(String searchExpression)
Long	getCertificationDefinitionCount(SearchCriteria searchCriteria)	Get a count of the Certification Definitions available
Map<Integer,List<String>>	getCertificationDefinitionDependancies(String certificationDefinitionName)	Finds event listeners and certification jobs which depend on the named certification definition
Long	getEventListenerCount(SearchCriteria searchCriteria)	Get a count of the Event Listeneres available
boolean	isExistingEventListener(String listenerName)	Determines whether or not an event listener of a given name exists
IDCConfiguration	loadCertificationConfiguration()	Loads the certification configuration from MDS or returns a default one, if none is stored.
CertificationDefinition	loadCertificationDefinition(Long certificationDefinitionId)	Retrieves a certification definition by id
CertificationDefinition	loadCertificationDefinition(String certificationName)	Retrieves a certification definition by name
EventListener	loadEventListener(String listenerName)	Retrieves an event listener
RiskConfiguration	loadRiskConfiguration()	loadRiskConfiguration: Retrieve risk config from MDS.
void	saveCertificationConfiguration(IDCConfiguration idcConfig)	Saves a certification configuration to MDS, potentially replacing one already stored, there.
Long	saveCertificationDefinition(CertificationDefinition definition)	Persists a certification definition.
void	saveRiskConfiguration(RiskConfiguration riskConfig)	Saves a risk configuration to MDS, potentially replacing one already stored, there.
EventListener	updateEventListener(EventListener listener)	Updates an event listener

Field Details

CONFIGURATION_KEY_CERTIFICATION

static final String CONFIGURATION_KEY_CERTIFICATION

See Also:

• Constant Field Values

CONFIGURATION_KEY_RISK_MAPPING

static final String CONFIGURATION_KEY_RISK_MAPPING

See Also:

• Constant Field Values

Method Details

saveCertificationConfiguration

void saveCertificationConfiguration(IDCConfiguration idcConfig)
                             throws CertificationEngineException

Saves a certification configuration to MDS, potentially replacing one already stored, there.

Parameters:

idcConfig - the configuration to store

Throws:

CertificationEngineException

loadCertificationConfiguration

IDCConfiguration loadCertificationConfiguration()
                                         throws CertificationEngineException

Loads the certification configuration from MDS or returns a default one, if none is stored.

Returns:

certification configuration

Throws:

CertificationEngineException

saveRiskConfiguration

void saveRiskConfiguration(RiskConfiguration riskConfig)
                    throws CertificationEngineException

Saves a risk configuration to MDS, potentially replacing one already stored, there.

Parameters:

riskConfig - the configuration to store

Throws:

CertificationEngineException

loadRiskConfiguration

RiskConfiguration loadRiskConfiguration()
                                 throws CertificationEngineException

loadRiskConfiguration: Retrieve risk config from MDS. If not found create a new config object. Never return null.

Returns:

risk config object

Throws:

CertificationEngineException

saveCertificationDefinition

Long saveCertificationDefinition(CertificationDefinition definition)
                          throws InvalidArgumentException,
CertificationEngineException,
AlreadyExistsException

Persists a certification definition. If the definition passed in has an ID (CertificationDefinition.getId()), it is regarded as an existing definition and updated. If not, it is created.

Parameters:

definition - the definition to store

Returns:

the ID that was created for the definition

Throws:

InvalidArgumentException - In case a null definition is passed as the argument (IAM-8010014)

AlreadyExistsException - if the definition to create (i. e. one with an id) has a name that's already used by another, existing definition (IAM-8010013)

CertificationEngineException - In case of any other exception

loadCertificationDefinition

CertificationDefinition loadCertificationDefinition(String certificationName)
                                             throws CertificationEngineException

Retrieves a certification definition by name

Parameters:

certificationName - the name of the certification definition to find

Returns:

the certification definition or null, if none was found

Throws:

CertificationEngineException

loadCertificationDefinition

CertificationDefinition loadCertificationDefinition(Long certificationDefinitionId)
                                             throws CertificationEngineException

Retrieves a certification definition by id

Parameters:

certificationDefinitionId - the id of the certification definition to find

Returns:

the certification definition or null, if none was found

Throws:

CertificationEngineException

findCertificationDefinitionsByType

List<CertificationDefinition> findCertificationDefinitionsByType(Integer certType,
 Set<String> retAttrs,
 Map<String,Object> configParams)
                                                          throws CertificationEngineException

Retrieves all certification definitions of a given type

Parameters:

certType - one of the TYPE_* constants in CertificationConstants

retAttrs - ignored

configParams - this can be used to control pagination. Pass STARTROW for the number of the first row to return ENDROW for the number of the last row to return Default is the first 25 rows

Returns:

a list of certification definitions of the specified type

Throws:

CertificationEngineException

findCertificationDefinitions

List<CertificationDefinition> findCertificationDefinitions(SearchCriteria searchCriteria,
 Set<String> retAttrs,
 Map<String,Object> configParams)
                                                    throws CertificationEngineException

Retrieves all configured certification definitions, constrained by a PaginationContext provided in the configParams where default pagination context parameters are used when not included in the configParams or when configParams is null.

Parameters:

searchCriteria - - Contains the SearchCriteria to be used for Filter

retAttrs - ignored

configParams - is used to control pagination. Pass STARTROW for the number of the first row to return ENDROW for the number of the last row to return SORTORDER ASCENDING/DESCENDING by name Default is the first 25 rows Default sort order is definintion name ASCENDING

Returns:

a list of certification definitions

Throws:

CertificationEngineException

deleteCertificationDefinition

void deleteCertificationDefinition(Long certificationDefinitionId)
                            throws CertificationEngineException

Deletes a certification definition

Parameters:

certificationDefinitionId - the ID of the certification definition to delete

Throws:

CertificationEngineException

getCertificationDefinitionCount

Long getCertificationDefinitionCount(SearchCriteria searchCriteria)
                              throws CertificationEngineException

Get a count of the Certification Definitions available

Parameters:

searchCriteria - ignored

Returns:

a count of the certification definition

Throws:

CertificationEngineException

createEventListener

EventListener createEventListener(EventListener listener)
                           throws CertificationEngineException,
AlreadyExistsException

Creates an event listener

Parameters:

listener - the listener to insert

Returns:

unchanged input parameter

Throws:

CertificationEngineException

AlreadyExistsException

updateEventListener

EventListener updateEventListener(EventListener listener)
                           throws CertificationEngineException

Updates an event listener

Parameters:

listener - the listener to update

Returns:

unchanged input parameter

Throws:

CertificationEngineException

deleteEventListener

void deleteEventListener(String listenerName)
                  throws CertificationEngineException

Deletes an event listener

Parameters:

listenerName - - name of listener to delete

Throws:

CertificationEngineException

loadEventListener

EventListener loadEventListener(String listenerName)
                         throws CertificationEngineException

Retrieves an event listener

Parameters:

listenerName - - name of listener to load

Returns:

EventListener

Throws:

CertificationEngineException

isExistingEventListener

boolean isExistingEventListener(String listenerName)
                         throws CertificationEngineException

Determines whether or not an event listener of a given name exists

Parameters:

listenerName -

Returns:

true, or false if the listener doesn't exist

Throws:

CertificationEngineException

findAllActiveEventListeners

List<EventListener> findAllActiveEventListeners()
                                         throws CertificationEngineException

Retrieves all event listeners where status is EventListener.STATUS_ENABLED

Returns:

a list of event listeners

Throws:

CertificationEngineException

findAllEventListeners

@Deprecated
List<EventListener> findAllEventListeners()
                                   throws CertificationEngineException

Deprecated.

Throws:

CertificationEngineException

findAllEventListeners

List<EventListener> findAllEventListeners(SearchCriteria searchCriteria,
 Set retAttrs,
 HashMap configParams)
                                   throws CertificationEngineException

Retrieves all event listeners

Parameters:

searchCriteria - - Contains the SearchCriteria to be used for Filter

retAttrs - ignored

configParams - this can be used to control pagination. Pass STARTROW for the number of the first row to return ENDROW for the number of the last row to return Default is the first 100 rows

Returns:

a list of event listeners

Throws:

CertificationEngineException

getEventListenerCount

Long getEventListenerCount(SearchCriteria searchCriteria)
                    throws CertificationEngineException

Get a count of the Event Listeneres available

Parameters:

searchCriteria - ignored

Returns:

a count of the event listeners

Throws:

CertificationEngineException

findComposites

Map<String,oracle.soa.management.facade.Composite> findComposites(String searchExpression)
                                                           throws CertificationEngineException

Parameters:

searchExpression - search string

Returns:

a map of qualified compsite name and composite

Throws:

CertificationEngineException

findDefaultComposites

Map<String,oracle.soa.management.facade.Composite> findDefaultComposites(String searchExpression)
                                                                  throws CertificationEngineException

Parameters:

searchExpression - search string

Returns:

a map of qualified compsite name and composite

Throws:

CertificationEngineException

createCertificationJob

boolean createCertificationJob(String certificationDefinitionName,
 String jobName,
 Trigger trigger)
                        throws AlreadyExistsException,
CertificationEngineException

Creates and schedules a job to run a certification for a given definition

Parameters:

certificationDefinitionName - name of the definition to build the certification from

jobName - the name the job should have

trigger - scheduling information

Returns:

true if successful

Throws:

CertificationEngineException

AlreadyExistsException

getCertificationDefinitionDependancies

Map<Integer,List<String>> getCertificationDefinitionDependancies(String certificationDefinitionName)
                                                          throws CertificationEngineException

Finds event listeners and certification jobs which depend on the named certification definition

Parameters:

certificationDefinitionName - the name of the certification definition to check

Returns:

a map with keys either CertificationConstants.CERTIFICATION_DEFINITION_DEPENDENCY_EVENT_LISTENER or CertificationConstants.CERTIFICATION_DEFINITION_DEPENDENCY_JOB and as values a list of names of either event listeners or certifiation jobs

Throws:

CertificationEngineException

findCustomReviewerMethods

List<Map<String,String>> findCustomReviewerMethods(Integer certType)
                                            throws CertificationEngineException

Retrieves all CustomReviewer methods for given certification type

Parameters:

certType - one of the TYPE_* constants in CertificationConstants

Returns:

a list of CustomReviewer methods of the specified type each Map object contains displayName, className

Throws:

CertificationEngineException

findCustomAccessReviewerMapName

List<String> findCustomAccessReviewerMapName(String mapName)
                                      throws CertificationEngineException

Retrieves all CustomAccessReviewer map names

Parameters:

mapName - filter string to restrict the list with mapName parameter. For eample, query will add where MAP_NAME like '%mapName%'

Returns:

a list of CustomAccessReviewer map names of the specified string

Throws:

CertificationEngineException