SILService (Oracle Fusion Middleware Java API Reference for Oracle Identity Manager)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.iam.grc.sod.api
Interface SILService

public interface SILService

This class represents SIL APIs to be used in SOD verification. The APIs will be called in following order:

registerSystemType : registers a new System Type
registerSystemContext : register a System Instance of registered System Type
registerScomp : register Service components required for the registered System Type
getSystemIds : give the IDs and Types of the Systems registered

SOD Verification:

getIdsFromTopology: gets Ids of Idm System, Sod Engine and Target system based on the topology provided
getDataTransformationInput: transforms the input data to a format understandable by SODEngine
isSynch: checks whether the Sod Engine is Synchronous or Asynchronous
For Synchronous Sod Engine:
executeSynchronousSoDSimulation : gives the Sod result
For Asynchronous Sod Engine:
executeAsynchronousSoDSimulation: gives a Ref Id
getPreventiveAsynchConflictSimulationResult : gives Sod result taking Ref Id as input

Method Summary
`AsynchAnalysisReference[]`	`executeAsynchronousSoDSimulation(SoDAnalysisInput[] sodInputData, long idmSysCtxRegID, long sodCtxRegID)` Starts a new asynchronous preventive simulation.
`SoDAnalysisResult[]`	`executeSynchronousSoDSimulation(SoDAnalysisInput[] sodInputData, long idmSysCtxRegID, long sodCtxRegID)` Returns the results of Synchronous conflict Simulation from SoD engine.
`SoDAnalysisInput[]`	`getDataTransformationInput(java.util.Map rawInput, long idmSysCtxRegID, long sodCtxRegID, long srcCtxRegId)` Transforms the entitlement data to a format understandable by SODEngine
`SILTopology`	`getIdsFromTopology(java.lang.String topologyName)` Returns a value object containing IDM System, SOD Engine and Target System Ids based on the topology name passed to it.
`SoDAnalysisResult[]`	`getPreventiveAsynchConflictSimulationResult(AsynchAnalysisReference[] openRequests, long idmSysCtxRegID, long sodCtxRegID)` Returns the results of Asynchronous conflict Simulation from SoD engine.
`java.util.List`	`getServiceCompData()` Returns the list of Service Components as given in Registration.xml.
`LookupResultSet`	`getSystemIds()` Returns the IDs and Types of the Systems registered with SIL
`java.util.List`	`getSystemTypeData()` Returns the list of System Types as given in Registration.xml.
`boolean`	`isSynch(long sodCtxRegID)` Returns true if Sod engine supports Synch call and False if Sod engine supports Asynch call
`void`	`registerScomps()` Registers a service component based on the content in Registration.xml.
`long`	`registerSystemContext(long systemTypeId, java.lang.String systemInstanceName, java.util.Map parameters)` Registers a system context with the framework.It first populates the System table and than validates the parameters and if found correct , it persists the parameters in encrypted form in the Table Parameters
`long`	`registerSystemType(java.lang.String typeName, java.lang.String systemTypeName)` Registers the system types given in Registration.xml

Method Detail

getSystemIds

LookupResultSet getSystemIds()
                             throws SILDBException

Returns the IDs and Types of the Systems registered with SIL

Returns:: LookupResultSet object which contains System Ids, System name and System Type name
Throws:: SILDBException

executeAsynchronousSoDSimulation

AsynchAnalysisReference[] executeAsynchronousSoDSimulation(SoDAnalysisInput[] sodInputData,
                                                           long idmSysCtxRegID,
                                                           long sodCtxRegID)
                                                           throws SILException,
                                                                  SILInfrastructureException,
                                                                  SILRegistrationException,
                                                                  SILServiceComponentException

Starts a new asynchronous preventive simulation. It should be the first operation a PEP should invoke to start with the asynchronous sod analysis

Parameters:: sodInputData - One or more instances of Actual input data value objects that are candidates for sod analysis; idmSysCtxRegID - Registration ID of the IdM system context; sodCtxRegID - Registration ID of the SoD engine system context
Returns:: AsynchAnalysisReference One or more instances of output data value objects that hold intermediate reference information pertaining to asynchronous sod analysis
Throws:: SILRegistrationException; SILException; SILInfrastructureException; SILServiceComponentException

getDataTransformationInput

SoDAnalysisInput[] getDataTransformationInput(java.util.Map rawInput,
                                              long idmSysCtxRegID,
                                              long sodCtxRegID,
                                              long srcCtxRegId)
                                              throws SILRegistrationException,
                                                     SILException,
                                                     SILInfrastructureException

Transforms the entitlement data to a format understandable by SODEngine

Parameters:: rawInput - Map(String,String) of raw entitlement data for transformation from PEP; idmSysCtxRegID - Registration ID for Idm system; sodCtxRegID - Registration ID for Sod Engine; srcCtxRegId - Registration ID for Target System
Returns:: SoDAnalysisInput input value object to be passed for Sod Analysis
Throws:: SILRegistrationException; SILException; SILInfrastructureException

getPreventiveAsynchConflictSimulationResult

SoDAnalysisResult[] getPreventiveAsynchConflictSimulationResult(AsynchAnalysisReference[] openRequests,
                                                                long idmSysCtxRegID,
                                                                long sodCtxRegID)
                                                                throws SILException,
                                                                       SILInfrastructureException,
                                                                       SILRegistrationException,
                                                                       SILServiceComponentException

Returns the results of Asynchronous conflict Simulation from SoD engine. It should be the next operation a PEP should invoke to conclude the asynchronous sod analysis, after the invocation of operation "executeAsynchronousSoDSimulation".

Parameters:: openRequests - intermediate reference information pertaining to asynchronous sod analysis; idmSysCtxRegID - Registration ID of the IdM system context; sodCtxRegID - Registration ID of the SoD engine system context
Returns:: One or more instances of output data value objects that hold the actual result of asynchronous sod analysis
Throws:: SILException; SILInfrastructureException; SILRegistrationException; SILServiceComponentException

isSynch

boolean isSynch(long sodCtxRegID)
                throws SILException,
                       SILRegistrationException

Returns true if Sod engine supports Synch call and False if Sod engine supports Asynch call

Parameters:: sodCtxRegID - Registration ID of the SoD engine system context
Returns:: boolean value stating synchronous or asynchronous nature of Sod System
Throws:: SILException; SILRegistrationException

executeSynchronousSoDSimulation

SoDAnalysisResult[] executeSynchronousSoDSimulation(SoDAnalysisInput[] sodInputData,
                                                    long idmSysCtxRegID,
                                                    long sodCtxRegID)
                                                    throws SILException,
                                                           SILRegistrationException,
                                                           SILInfrastructureException,
                                                           SILServiceComponentException

Returns the results of Synchronous conflict Simulation from SoD engine.

Parameters:: sodInputData - One or more instances of Actual input data value objects that are candidates for sod analysis; idmSysCtxRegID - Registration ID of the IdM system context; sodCtxRegID - Registration ID of the SoD engine system context
Returns:: One or more instances of output data value objects that hold the actual result of asynchronous sod analysis
Throws:: SILException; SILRegistrationException; SILInfrastructureException; SILServiceComponentException

getIdsFromTopology

SILTopology getIdsFromTopology(java.lang.String topologyName)
                               throws SILException,
                                      SILTopologyException

Returns a value object containing IDM System, SOD Engine and Target System Ids based on the topology name passed to it.

Parameters:: topologyName - name of the topology registered with SIL
Returns:: Topology value object corresponding to topologyName
Throws:: SILException; SILTopologyException; SILRegistrationException; SILTopologyException

getSystemTypeData

java.util.List getSystemTypeData()
                                 throws SILRegistrationException

Returns the list of System Types as given in Registration.xml.

Returns:: List of System Types
Throws:: SILRegistrationException

getServiceCompData

java.util.List getServiceCompData()
                                  throws SILRegistrationException

Returns the list of Service Components as given in Registration.xml.

Returns:: List of System Types
Throws:: SILRegistrationException

registerScomps

void registerScomps()
                    throws SILRegistrationException

Registers a service component based on the content in Registration.xml.

Throws:: SILRegistrationException

registerSystemType

long registerSystemType(java.lang.String typeName,
                        java.lang.String systemTypeName)
                        throws SILRegistrationException

Registers the system types given in Registration.xml

Parameters:: typeName - as provided in the xml, possible values will be 'IdM System', 'SoD Engine' or 'Sod Source DataStore'; systemTypeName - name of the system type
Returns:: key of the system type added or updated in the DB
Throws:: SILRegistrationException

registerSystemContext

long registerSystemContext(long systemTypeId,
                           java.lang.String systemInstanceName,
                           java.util.Map parameters)
                           throws SILRegistrationException

Registers a system context with the framework.It first populates the System table and than validates the parameters and if found correct , it persists the parameters in encrypted form in the Table Parameters

Parameters:: systemTypeId - registration ID of the system type to which this context belongs; parameters - Map containing Parameters names and their values
Returns:: registration ID assigned by the framework
Throws:: SILRegistrationException