Package org.opends.server.api.plugin

Record Class PluginResult.IntermediateResponse

java.lang.Object
java.lang.Record
org.opends.server.api.plugin.PluginResult.IntermediateResponse
Record Components:
continueProcessing - Whether to continue operation processing
continuePluginProcessing - Whether to invoke the rest of the plugins
sendResponse - Whether to send the intermediate response to the client
result - The result for this result
All Implemented Interfaces:
PluginResult.OperationResult
Enclosing class:
PluginResult
public static record PluginResult.IntermediateResponse(boolean continueProcessing, boolean continuePluginProcessing, boolean sendResponse, Result result) extends Record 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.

  • Constructor Details

    • IntermediateResponse

      public IntermediateResponse(boolean continueProcessing, boolean continuePluginProcessing, boolean sendResponse, Result result)
      Creates an instance of a IntermediateResponse record class.
      Parameters:
      continueProcessing - the value for the continueProcessing record component
      continuePluginProcessing - the value for the continuePluginProcessing record component
      sendResponse - the value for the sendResponse record component
      result - the value for the result record component

  • Method Details

    • 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.

    • skipFurtherPluginProcessing

      public static PluginResult.IntermediateResponse skipFurtherPluginProcessing(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, 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 - A 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, 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 - A message explaining why processing should stop.
      Returns:
      a new stop processing intermediate response plugin result.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • continueProcessing

      public boolean continueProcessing()
      Returns the value of the continueProcessing record component.
      Specified by:
      continueProcessing in interface PluginResult.OperationResult
      Returns:
      the value of the continueProcessing record component

    • continuePluginProcessing

      public boolean continuePluginProcessing()
      Returns the value of the continuePluginProcessing record component.
      Returns:
      the value of the continuePluginProcessing record component

    • sendResponse

      public boolean sendResponse()
      Returns the value of the sendResponse record component.
      Returns:
      the value of the sendResponse record component

    • result

      public Result result()
      Returns the value of the result record component.
      Specified by:
      result in interface PluginResult.OperationResult
      Returns:
      the value of the result record component