S
- The type of result.public abstract class AbstractExtendedResultDecoder<S extends ExtendedResult> extends Object implements ExtendedResultDecoder<S>
ExtendedResultDecoder
interface, to minimize the effort required to
implement this interface.Modifier | Constructor and Description |
---|---|
protected |
AbstractExtendedResultDecoder()
Creates a new abstract extended result decoder.
|
Modifier and Type | Method and Description |
---|---|
S |
adaptDecodeException(DecodeException exception)
Creates a new extended operation error result using the provided decoding
exception.
|
abstract S |
decodeExtendedResult(ExtendedResult result,
DecodeOptions options)
Decodes the provided extended operation result as a
Result of
type S . |
abstract S |
newExtendedErrorResult(ResultCode resultCode,
String matchedDN,
CharSequence diagnosticMessage)
Creates a new extended error result using the provided result code,
matched DN, and diagnostic message.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExtendedResultClass
protected AbstractExtendedResultDecoder()
public S adaptDecodeException(DecodeException exception)
ExtendedResultDecoder
DecodeException
encountered while decoding an extended request or result. The returned
error result will have the result code ResultCode.PROTOCOL_ERROR
.adaptDecodeException
in interface ExtendedResultDecoder<S extends ExtendedResult>
exception
- The decoding exception to be adapted.public abstract S decodeExtendedResult(ExtendedResult result, DecodeOptions options) throws DecodeException
ExtendedResultDecoder
Result
of
type S
. This method is called when an extended result is received
from the server. The result may indicate success or failure of the
extended request.decodeExtendedResult
in interface ExtendedResultDecoder<S extends ExtendedResult>
result
- The extended operation result to be decoded.options
- The set of decode options which should be used when decoding
the extended operation result.DecodeException
- If the provided extended operation result could not be
decoded. For example, if the request name was wrong, or if
the request value was invalid.public abstract S newExtendedErrorResult(ResultCode resultCode, String matchedDN, CharSequence diagnosticMessage)
ExtendedResultDecoder
Result
of type S
.newExtendedErrorResult
in interface ExtendedResultDecoder<S extends ExtendedResult>
resultCode
- The result code.matchedDN
- The matched DN, which may be empty if none was provided.diagnosticMessage
- The diagnostic message, which may be empty if none was
provided.Copyright 2010-2022 ForgeRock AS.