org.opends.server.api.plugin
Class PluginResult.PreParse

java.lang.Object
  extended by org.opends.server.api.plugin.PluginResult.PreParse
Enclosing class:
PluginResult

public static final class PluginResult.PreParse
extends java.lang.Object

Defines a pre parse 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.PreParse continueOperationProcessing()
          Defines a continue processing pre parse 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.
static PluginResult.PreParse skipFurtherPluginProcesssing()
          Defines a skip further plugin processing pre parse plugin result.
static PluginResult.PreParse stopProcessing(ResultCode resultCode, Message errorMessage)
          Contrust a new stop processing pre parse plugin result.
static PluginResult.PreParse stopProcessing(ResultCode resultCode, Message errorMessage, DN matchedDN, java.util.List<java.lang.String> referralURLs)
          Defines a new stop processing pre parse 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.PreParse continueOperationProcessing()
Defines a continue processing pre parse plugin result.

Returns:
a continue processing pre parse plugin result.

skipFurtherPluginProcesssing

public static PluginResult.PreParse skipFurtherPluginProcesssing()
Defines a skip further plugin processing pre parse plugin result.

Returns:
a skip further plugin processing pre parse plugin result.

stopProcessing

public static PluginResult.PreParse stopProcessing(ResultCode resultCode,
                                                   Message errorMessage,
                                                   DN matchedDN,
                                                   java.util.List<java.lang.String> referralURLs)
Defines a new stop processing pre parse plugin result.

Parameters:
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 pre parse plugin result.

stopProcessing

public static PluginResult.PreParse stopProcessing(ResultCode resultCode,
                                                   Message errorMessage)
Contrust a new stop processing pre parse plugin result.

Parameters:
resultCode - The result code for this result.
errorMessage - An message explaining why processing should stop.
Returns:
a new stop processing pre parse plugin result.

continueProcessing

public boolean continueProcessing()
Whether to continue operation processing.

Returns:
true if processing should continue or false otherwise.

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.

getErrorMessage

public Message getErrorMessage()
Retrieves the error message if continueProcessing returned false.

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

getResultCode

public ResultCode getResultCode()
Retrieves the result code for the operation if continueProcessing returned false.

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

getMatchedDN

public DN getMatchedDN()
Retrieves the matched DN for the operation if continueProcessing returned false.

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

getReferralURLs

public java.util.List<java.lang.String> getReferralURLs()
Retrieves the referral URLs for the operation if continueProcessing returned false.

Returns:
the refferal URLs for the operation or null if none is provided.