public static final class PluginResult.IntermediateResponse extends Object implements PluginResult.OperationResult
Modifier and Type | Method and 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.
|
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,
LocalizableMessage errorMessage)
Constructs a new stop processing intermediate response plugin result.
|
static PluginResult.IntermediateResponse |
stopProcessing(boolean sendResponse,
ResultCode resultCode,
LocalizableMessage errorMessage,
Dn matchedDN,
List<String> referralURLs)
Defines a new stop processing intermediate response plugin result.
|
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, LocalizableMessage errorMessage, Dn matchedDN, List<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, LocalizableMessage 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()
PluginResult.OperationResult
continueProcessing
in interface PluginResult.OperationResult
true
if processing on the associated operation should continue, or false
if it should
stop.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 LocalizableMessage getErrorMessage()
PluginResult.OperationResult
PluginResult.OperationResult.continueProcessing()
returned false
.getErrorMessage
in interface PluginResult.OperationResult
null
if none is provided.public ResultCode getResultCode()
PluginResult.OperationResult
PluginResult.OperationResult.continueProcessing()
returned false
.getResultCode
in interface PluginResult.OperationResult
null
if none is provided.public Dn getMatchedDN()
PluginResult.OperationResult
PluginResult.OperationResult.continueProcessing()
returned false
.getMatchedDN
in interface PluginResult.OperationResult
null
if none is provided.public List<String> getReferralURLs()
PluginResult.OperationResult
PluginResult.OperationResult.continueProcessing()
returned false
.getReferralURLs
in interface PluginResult.OperationResult
null
if none is provided.Copyright 2010-2022 ForgeRock AS.