Oracle Fusion Middleware Java API Reference for Oracle Privileged Account Manager
Release 11g Release 2(11.1.2)

E50216-01
A C G P R S 

A

appendLog(String) - Method in class com.oracle.idm.opam.plugin.context.PluginResult
Append the user-defined log

C

clearLog() - Method in class com.oracle.idm.opam.plugin.context.PluginResult
Clear the user-defined log
CODE_FAILURE - Static variable in class com.oracle.idm.opam.plugin.context.PluginResult
Plugin status: Failure
CODE_SUCCESS - Static variable in class com.oracle.idm.opam.plugin.context.PluginResult
Plugin status: Success
com.oracle.idm.opam.plugin.context - package com.oracle.idm.opam.plugin.context
 
com.oracle.idm.opam.plugin.interfaces - package com.oracle.idm.opam.plugin.interfaces
 

G

getAccountJSON() - Method in class com.oracle.idm.opam.plugin.context.PluginContext
Get the account JSON
getAuthContextJSON() - Method in class com.oracle.idm.opam.plugin.context.PluginContext
Get the Auth Context JSON
getErrorCode() - Method in class com.oracle.idm.opam.plugin.context.PluginResult
Get the error code
getErrorMsg() - Method in class com.oracle.idm.opam.plugin.context.PluginResult
Get the error message
getGUID() - Method in class com.oracle.idm.opam.plugin.context.PluginContext
Get the resource GUID if applicable
getHTTPResponseEntity() - Method in class com.oracle.idm.opam.plugin.context.PluginContext
Get the HTTP response entity
getHTTPResponseStatus() - Method in class com.oracle.idm.opam.plugin.context.PluginContext
Get the HTTP response status
getLog() - Method in class com.oracle.idm.opam.plugin.context.PluginResult
Get the user-defined log
getOperationJSON() - Method in class com.oracle.idm.opam.plugin.context.PluginContext
Get the operation JSON
getPluginResult() - Method in class com.oracle.idm.opam.plugin.context.PluginContext
Get PluginResult object
getResultJSON() - Method in class com.oracle.idm.opam.plugin.context.PluginResult
Get the request JSON body
getTargetJSON() - Method in class com.oracle.idm.opam.plugin.context.PluginContext
Get the target JSON

P

PluginContext - Class in com.oracle.idm.opam.plugin.context
PluginContext represents a plugin's relevent configuration information, including target/account info, OPAM operation info, requestor info, HTTP response status (post-plugin only) and HTTP response entity (post-plugin only).
The Oracle Privileged Account Manager server creates the PluginContext object during plug-in invocation and sends it to the plug-in.
For target and account JSON format information see OPAM Administrator's Guide Appendx B, Working with Oracle Privileged Account Manager's RESTful Interface
Operation object will have the following JSON format:

{"resourceType": RESOURCE_TYPE, "operationName":OPERATION_NAME}

Requestor object will look like this:

{"requestor": REQUESTOR, "requestorGroups":[REQUESTOR_GROUP1, REQUESTOR_GROUP2]}

HTTP response status (post-plugin only) follows the standard format (ex, 200 on operation success, 401 on insufficient privilege etc.)
HTTP response entity (post-plugin only) contains the result returned by OPAM Rest API.
PluginContext(Map<String, String>) - Constructor for class com.oracle.idm.opam.plugin.context.PluginContext
 
PluginResult - Class in com.oracle.idm.opam.plugin.context
PluginResult contains the information for plugin execution status, error message (if applicable), modifiable request JSON body and user-defined log.
PluginResult() - Constructor for class com.oracle.idm.opam.plugin.context.PluginResult
Create a PluginResult object with status equals to success
PluginResult(String, int, String) - Constructor for class com.oracle.idm.opam.plugin.context.PluginResult
Create a PluginResult object with given information
PostPlugin - Interface in com.oracle.idm.opam.plugin.interfaces
The interface for users to implement post-plugins
PrePlugin - Interface in com.oracle.idm.opam.plugin.interfaces
The interface for users to implement pre-plugins

R

runPostPlugin(PluginContext, String, String) - Method in interface com.oracle.idm.opam.plugin.interfaces.PostPlugin
The function to invoke pre-plugin
runPrePlugin(PluginContext, String, String) - Method in interface com.oracle.idm.opam.plugin.interfaces.PrePlugin
The function to invoke pre-plugin

S

setErrorCode(int) - Method in class com.oracle.idm.opam.plugin.context.PluginResult
Set the error code
setErrorMsg(String) - Method in class com.oracle.idm.opam.plugin.context.PluginResult
Set the error message
setPluginResult(PluginResult) - Method in class com.oracle.idm.opam.plugin.context.PluginContext
Set the PluginResult object
setResultJSON(String) - Method in class com.oracle.idm.opam.plugin.context.PluginResult
Set the request JSON body
A C G P R S 
Oracle Fusion Middleware Java API Reference for Oracle Privileged Account Manager
Release 11g Release 2(11.1.2)

E50216-01