|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.plugin.PluginResult.IntermediateResponse
public static final class PluginResult.IntermediateResponse
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 | |
---|---|
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()
Whether to continue operation processing. |
Message |
getErrorMessage()
Retrieves the error message if continueProcessing
returned false . |
DN |
getMatchedDN()
Retrieves the matched DN for the operation if continueProcessing returned false . |
java.util.List<java.lang.String> |
getReferralURLs()
Retrieves the referral URLs for the operation if continueProcessing returned false . |
ResultCode |
getResultCode()
Retrieves the result code for the operation if 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,
Message errorMessage)
Contrust a new stop processing intermediate response plugin result. |
static PluginResult.IntermediateResponse |
stopProcessing(boolean sendResponse,
ResultCode resultCode,
Message errorMessage,
DN matchedDN,
java.util.List<java.lang.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 |
---|
public static PluginResult.IntermediateResponse continueOperationProcessing(boolean sendResponse)
sendResponse
- Whether to send the intermediate response
to the client.
public static PluginResult.IntermediateResponse skipFurtherPluginProcesssing(boolean sendResponse)
sendResponse
- Whether to send the intermediate response
to the client.
public static PluginResult.IntermediateResponse stopProcessing(boolean sendResponse, ResultCode resultCode, Message errorMessage, DN matchedDN, java.util.List<java.lang.String> referralURLs)
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.
public static PluginResult.IntermediateResponse stopProcessing(boolean sendResponse, ResultCode resultCode, Message errorMessage)
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.
public boolean continueProcessing()
true
if processing should continue
or false
otherwise.public boolean continuePluginProcessing()
true
if the rest of the plugins should
be invoked for false
to skip the rest of the
plugins.public boolean sendResponse()
true
if the intermediate response should
be sent to the client or false
otherwise.public Message getErrorMessage()
continueProcessing
returned false
.
null
if none is provided.public ResultCode getResultCode()
continueProcessing
returned false
.
null
if none is provided.public DN getMatchedDN()
continueProcessing
returned false
.
null
if none is provided.public java.util.List<java.lang.String> getReferralURLs()
continueProcessing
returned false
.
null
if none is provided.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |