Package org.opends.server.api.plugin

Class PluginResult.IntermediateResponse

java.lang.Object

org.opends.server.api.plugin.PluginResult.IntermediateResponse

All Implemented Interfaces:

PluginResult.OperationResult

Enclosing class:

PluginResult

public static final class PluginResult.IntermediateResponse
extends Object
implements PluginResult.OperationResult

Defines an intermediate response plugin result for core server operation processing consisting of either continue, skip further plugins, or stop operation processing with a result code, matched DN, referral URLs, and error message.

Method Summary

Modifier and Type	Method	Description
static PluginResult.IntermediateResponse	continueOperationProcessing(boolean sendResponse)	Defines a continue processing intermediate response plugin result.
boolean	continuePluginProcessing()	Whether to invoke the rest of the plugins.
boolean	continueProcessing()	Indicates whether processing on the associated operation should continue.
org.forgerock.i18n.LocalizableMessage	getErrorMessage()	Retrieves the error message if PluginResult.OperationResult.continueProcessing() returned false.
DN	getMatchedDN()	Retrieves the matched DN for the operation if PluginResult.OperationResult.continueProcessing() returned false.
List<String>	getReferralURLs()	Retrieves the referral URLs for the operation if PluginResult.OperationResult.continueProcessing() returned false.
ResultCode	getResultCode()	Retrieves the result code for the operation if PluginResult.OperationResult.continueProcessing() returned false.
boolean	sendResponse()	Whether to send the intermediate response to the client.
static PluginResult.IntermediateResponse	skipFurtherPluginProcesssing(boolean sendResponse)	Defines a skip further plugin processing intermediate response plugin result.
static PluginResult.IntermediateResponse	stopProcessing(boolean sendResponse, ResultCode resultCode, org.forgerock.i18n.LocalizableMessage errorMessage)	Constructs a new stop processing intermediate response plugin result.
static PluginResult.IntermediateResponse	stopProcessing(boolean sendResponse, ResultCode resultCode, org.forgerock.i18n.LocalizableMessage errorMessage, DN matchedDN, List<String> referralURLs)	Defines a new stop processing intermediate response plugin result.

Methods inherited from class java.lang.Object

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

Method Detail

continueOperationProcessing

public static PluginResult.IntermediateResponse continueOperationProcessing(boolean sendResponse)

Defines a continue processing intermediate response plugin result.

Parameters:

sendResponse - Whether to send the intermediate response to the client.

Returns:

a continue processing intermediate response plugin result.

skipFurtherPluginProcesssing

public static PluginResult.IntermediateResponse skipFurtherPluginProcesssing(boolean sendResponse)

Defines a skip further plugin processing intermediate response plugin result.

Parameters:

sendResponse - Whether to send the intermediate response to the client.

Returns:

a skip further plugin processing intermediate response plugin result.

stopProcessing

public static PluginResult.IntermediateResponse stopProcessing(boolean sendResponse,
                                                               ResultCode resultCode,
                                                               org.forgerock.i18n.LocalizableMessage errorMessage,
                                                               DN matchedDN,
                                                               List<String> referralURLs)

Defines a new stop processing intermediate response plugin result.

Parameters:

sendResponse - Whether to send the intermediate response to the client.

resultCode - The result code for this result.

errorMessage - An message explaining why processing should stop.

matchedDN - The matched DN for this result.

referralURLs - The set of referral URLs for this result.

Returns:

a new stop processing intermediate response plugin result.

stopProcessing

public static PluginResult.IntermediateResponse stopProcessing(boolean sendResponse,
                                                               ResultCode resultCode,
                                                               org.forgerock.i18n.LocalizableMessage errorMessage)

Constructs a new stop processing intermediate response plugin result.

Parameters:

sendResponse - Whether to send the intermediate response to the client.

resultCode - The result code for this result.

errorMessage - An message explaining why processing should stop.

Returns:

a new stop processing intermediate response plugin result.

continueProcessing

public boolean continueProcessing()

Description copied from interface: PluginResult.OperationResult

Indicates whether processing on the associated operation should continue.

Specified by:

continueProcessing in interface PluginResult.OperationResult

Returns:

true if processing on the associated operation should continue, or false if it should stop.

continuePluginProcessing

public boolean continuePluginProcessing()

Whether to invoke the rest of the plugins.

Returns:

true if the rest of the plugins should be invoked for false to skip the rest of the plugins.

sendResponse

public boolean sendResponse()

Whether to send the intermediate response to the client.

Returns:

true if the intermediate response should be sent to the client or false otherwise.

getErrorMessage

public org.forgerock.i18n.LocalizableMessage getErrorMessage()

Description copied from interface: PluginResult.OperationResult

Retrieves the error message if PluginResult.OperationResult.continueProcessing() returned false.

Specified by:

getErrorMessage in interface PluginResult.OperationResult

Returns:

An error message explaining why processing should stop or null if none is provided.

getResultCode

public ResultCode getResultCode()

Description copied from interface: PluginResult.OperationResult

Retrieves the result code for the operation if PluginResult.OperationResult.continueProcessing() returned false.

Specified by:

getResultCode in interface PluginResult.OperationResult

Returns:

the result code for the operation or null if none is provided.

getMatchedDN

public DN getMatchedDN()

Description copied from interface: PluginResult.OperationResult

Retrieves the matched DN for the operation if PluginResult.OperationResult.continueProcessing() returned false.

Specified by:

getMatchedDN in interface PluginResult.OperationResult

Returns:

the matched DN for the operation or null if none is provided.

getReferralURLs

public List<String> getReferralURLs()

Description copied from interface: PluginResult.OperationResult

Retrieves the referral URLs for the operation if PluginResult.OperationResult.continueProcessing() returned false.

Specified by:

getReferralURLs in interface PluginResult.OperationResult

Returns:

the referral URLs for the operation or null if none is provided.