oracle.security.fed.plugins.fed.msgprocessing

Class OIFMessageProcessingPlugin

java.lang.Object

oracle.security.am.plugin.OAMAbstractAMPlugin

oracle.security.am.plugin.AbstractAMPlugin

oracle.security.fed.plugins.fed.msgprocessing.OIFMessageProcessingPlugin

All Implemented Interfaces:

GenericPluginService, OIFMessageProcessingIFPlugin

public abstract class OIFMessageProcessingPlugin
extends AbstractAMPlugin
implements OIFMessageProcessingIFPlugin

OIF Message Processing plug-in interface that will be exposed to the plug-in developers. All the plug-in implementations should extend OIFMessageProcessingPlugin class. The process() method will implement the logic required to process and modify the message. The initialize method will get the plugin configuration Plug-ins that needs to handle the resource cleanup should override shutdown(Map < String, Object > OAMEnvironmentContext)

Since:

OAM 11.1.2.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.security.am.plugin.GenericPluginService

GenericPluginService.QueryKey

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.logging.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
OIFMessageProcessingPlugin()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getDescription()
abstract java.util.Map<java.lang.String,MonitoringData>	getMonitoringData() plug-in can return monitoring data after plug-in execution is complete.
abstract boolean	getMonitoringStatus() set the monitoring status for the plug-in.
abstract java.lang.String	getPluginName()
abstract int	getRevision()
abstract ExecutionStatus	process(MessageContext context) Plugin implementations will extract data from context information passed in, implement logic to process and modify the message and return the ExectionStatus back to caller.
abstract void	setMonitoringStatus(boolean status)

Methods inherited from class oracle.security.am.plugin.AbstractAMPlugin

shutdownPlugin, start, startPlugin, stop

Methods inherited from class oracle.security.am.plugin.OAMAbstractAMPlugin

getID, getLogger, getMaxWaitIntervel, getPluginConfig, initialize, poweronSelfTest, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

protected static java.util.logging.Logger LOGGER

Constructor Detail

OIFMessageProcessingPlugin

public OIFMessageProcessingPlugin()

Method Detail

process

public abstract ExecutionStatus process(MessageContext context)
                                 throws MessageProcessingException

Plugin implementations will extract data from context information passed in, implement logic to process and modify the message and return the ExectionStatus back to caller. The MessageContext.message will contain the incoming/outgoing message as a UTF-8 String: it will represent the message as processed by Oracle Identity Federation and might not be identical to the data received/sent. The modified message should be put into the MessageContext.modifiedMessage variable if modified

Specified by:

process in interface OIFMessageProcessingIFPlugin

Parameters:

context -

Returns:

Throws:

MessageProcessingException

getDescription

public abstract java.lang.String getDescription()

Specified by:

getDescription in interface GenericPluginService

Returns:

the description

getMonitoringData

public abstract java.util.Map<java.lang.String,MonitoringData> getMonitoringData()

Description copied from interface: GenericPluginService

plug-in can return monitoring data after plug-in execution is complete. Server will log this data.

Specified by:

getMonitoringData in interface GenericPluginService

Returns:

the monitoring data

getMonitoringStatus

public abstract boolean getMonitoringStatus()

Description copied from interface: GenericPluginService

set the monitoring status for the plug-in.

Specified by:

getMonitoringStatus in interface GenericPluginService

Returns:

the monitoring status

getPluginName

public abstract java.lang.String getPluginName()

Specified by:

getPluginName in interface GenericPluginService

Returns:

String name of the plug-in.

getRevision

public abstract int getRevision()

Specified by:

getRevision in interface GenericPluginService

Returns:

the revision

setMonitoringStatus

public abstract void setMonitoringStatus(boolean status)

Specified by:

setMonitoringStatus in interface GenericPluginService

Parameters:

status - the new monitoring status