Class PluginResult.PreOperation

  • All Implemented Interfaces:
    PluginResult.OperationResult
    Enclosing class:
    PluginResult

    public static final class PluginResult.PreOperation
    extends Object
    implements PluginResult.OperationResult
    Defines a pre operation 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 Detail

      • continueOperationProcessing

        public static PluginResult.PreOperation continueOperationProcessing()
        Defines a continue processing pre operation plugin result.
        Returns:
        a continue processing pre operation plugin result.
      • skipFurtherPluginProcessing

        public static PluginResult.PreOperation skipFurtherPluginProcessing()
        Defines a skip further plugin processing pre operation plugin result.
        Returns:
        a skip further plugin processing pre operation plugin result.
      • stopProcessing

        public static PluginResult.PreOperation stopProcessing​(ResultCode resultCode,
                                                               LocalizableMessage errorMessage,
                                                               Dn matchedDN,
                                                               List<String> referralURLs)
        Defines a new stop processing pre operation 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 operation plugin result.
      • stopProcessing

        public static PluginResult.PreOperation stopProcessing​(ResultCode resultCode,
                                                               LocalizableMessage errorMessage)
        Constructs a new stop processing pre operation plugin result.
        Parameters:
        resultCode - The result code for this result.
        errorMessage - An message explaining why processing should stop.
        Returns:
        a new stop processing pre operation 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.