com.oracle.idm.opam.plugin.context

Class PluginResult

java.lang.Object

com.oracle.idm.opam.plugin.context.PluginResult

public class PluginResult
extends java.lang.Object

PluginResult contains the information for plugin execution status, error message (if applicable), modifiable request JSON body and user-defined log. The plug-in creates PluginResult and uses it to send information back to the Oracle Privileged Account Manager server.
Here are some examples to create a PluginResult object:

PluginResult ret = new PluginResult(reqBodyJSON, PluginResult.CODE_FAILURE, e.getMessage());
PluginResult ret = new PluginResult(reqBodyJSON, PluginResult.CODE_SUCCESS, null);

Field Summary

Fields

Modifier and Type	Field and Description
static int	CODE_FAILURE Plugin status: Failure
static int	CODE_SUCCESS Plugin status: Success

Constructor Summary

Constructors

Constructor and Description
PluginResult() Create a PluginResult object with status equals to success
PluginResult(java.lang.String resultJSON, int plgErrorCode, java.lang.String plgErrorMsg) Create a PluginResult object with given information

Method Summary

Methods

Modifier and Type	Method and Description
void	appendLog(java.lang.String str) Append the user-defined log
void	clearLog() Clear the user-defined log
int	getErrorCode() Get the error code
java.lang.String	getErrorMsg() Get the error message
java.lang.String	getLog() Get the user-defined log
java.lang.String	getResultJSON() Get the request JSON body
void	setErrorCode(int errorCode) Set the error code
void	setErrorMsg(java.lang.String errorMsg) Set the error message
void	setResultJSON(java.lang.String resultJSON) Set the request JSON body

Methods inherited from class java.lang.Object

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

Field Detail

CODE_SUCCESS

public static final int CODE_SUCCESS

Plugin status: Success

See Also:

Constant Field Values

CODE_FAILURE

public static final int CODE_FAILURE

Plugin status: Failure

See Also:

Constant Field Values

Constructor Detail

PluginResult

public PluginResult()

Create a PluginResult object with status equals to success

PluginResult

public PluginResult(java.lang.String resultJSON,
            int plgErrorCode,
            java.lang.String plgErrorMsg)

Create a PluginResult object with given information

Method Detail

setResultJSON

public void setResultJSON(java.lang.String resultJSON)

Set the request JSON body

Parameters:

resultJSON - Set request body with the value

getResultJSON

public java.lang.String getResultJSON()

Get the request JSON body

Returns:

Request JSON body

setErrorCode

public void setErrorCode(int errorCode)

Set the error code

Parameters:

errorCode - Set plugin execution error code

getErrorCode

public int getErrorCode()

Get the error code

Returns:

Plugin error code

setErrorMsg

public void setErrorMsg(java.lang.String errorMsg)

Set the error message

Parameters:

errorMsg - Set plugin execution error message

getErrorMsg

public java.lang.String getErrorMsg()

Get the error message

Returns:

Plugin error message

appendLog

public void appendLog(java.lang.String str)

Append the user-defined log

Parameters:

str - The string to be appended to log

clearLog

public void clearLog()

Clear the user-defined log

getLog

public java.lang.String getLog()

Get the user-defined log

Returns:

User-defined log