Package org.forgerock.opendj.ldap.messages

Interface GenericExtendedResult

    • Method Detail

      • getCause

        Throwable getCause()
        Description copied from interface: Result
        Returns the throwable cause associated with this result if available. A cause may be provided in cases where a result indicates a failure due to a client-side error.
        Specified by:
        getCause in interface ExtendedResult
        Specified by:
        getCause in interface Result
        Returns:
        The throwable cause, or null if none was provided.

      • getControl

        <C extends Control> C getControl​(ControlDecoder<C> decoder,
                                 DecodeOptions options)
                          throws DecodeException
        Description copied from interface: ProtocolOp
        Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.
        Specified by:
        getControl in interface ExtendedResult
        Specified by:
        getControl in interface ProtocolOp
        Specified by:
        getControl in interface Result
        Type Parameters:
        C - The type of control to be decoded and returned.
        Parameters:
        decoder - The control decoder.
        options - The set of decode options which should be used when decoding the control.
        Returns:
        The decoded control, or null if the control is not included with this protocol-op.
        Throws:
        DecodeException - If the control could not be decoded because it was malformed in some way (e.g. the control value was missing, or its content could not be decoded).

      • getControls

        List<Control> getControls()
        Description copied from interface: ProtocolOp
        Returns a List containing the controls included with this protocol-op. The returned List may be modified if permitted by this protocol-op.
        Specified by:
        getControls in interface ExtendedResult
        Specified by:
        getControls in interface ProtocolOp
        Specified by:
        getControls in interface Result
        Returns:
        A List containing the controls.

      • getMatchedDn

        String getMatchedDn()
        Description copied from interface: Result
        Returns the matched DN associated with this result.
        Specified by:
        getMatchedDn in interface ExtendedResult
        Specified by:
        getMatchedDn in interface Result
        Returns:
        The matched DN, which may be empty if none was provided (never null).

      • getOid

        String getOid()
        Description copied from interface: ExtendedResult
        Returns the numeric OID, if any, associated with this extended result.
        Specified by:
        getOid in interface ExtendedResult
        Returns:
        The numeric OID associated with this extended result, or null if there is no OID.

      • getReferralUris

        List<String> getReferralUris()
        Description copied from interface: Result
        Returns a List containing the referral URIs included with this result. The returned List may be modified if permitted by this result.
        Specified by:
        getReferralUris in interface ExtendedResult
        Specified by:
        getReferralUris in interface Result
        Returns:
        A List containing the referral URIs.

      • getValue

        ByteString getValue()
        Description copied from interface: ExtendedResult
        Returns the value, if any, associated with this extended result. Its format is defined by the specification of this extended result.
        Specified by:
        getValue in interface ExtendedResult
        Returns:
        The value associated with this extended result, or null if there is no value.

      • hasValue

        boolean hasValue()
        Description copied from interface: ExtendedResult
        Returns true if this extended result has a value. In some circumstances it may be useful to determine if a extended result has a value, without actually calculating the value and incurring any performance costs.
        Specified by:
        hasValue in interface ExtendedResult
        Returns:
        true if this extended result has a value, or false if there is no value.

      • isReferral

        boolean isReferral()
        Description copied from interface: Result
        Indicates whether a referral needs to be chased in order to complete the operation.

        Specifically, this method returns true if the result code is equal to ResultCode.REFERRAL.

        Specified by:
        isReferral in interface ExtendedResult
        Specified by:
        isReferral in interface Result
        Returns:
        true if a referral needs to be chased, otherwise false.

      • isSuccess

        boolean isSuccess()
        Description copied from interface: Result
        Indicates whether the request succeeded or not. This method will return {code true} for all non-error responses.
        Specified by:
        isSuccess in interface ExtendedResult
        Specified by:
        isSuccess in interface Result
        Returns:
        true if the request succeeded, otherwise false.

      • setCause

        GenericExtendedResult setCause​(Throwable cause)
        Description copied from interface: Result
        Sets the throwable cause associated with this result if available. A cause may be provided in cases where a result indicates a failure due to a client-side error.
        Specified by:
        setCause in interface ExtendedResult
        Specified by:
        setCause in interface Result
        Parameters:
        cause - The throwable cause, which may be null indicating that none was provided.
        Returns:
        This result.

      • setMatchedDn

        GenericExtendedResult setMatchedDn​(String dn)
        Description copied from interface: Result
        Sets the matched DN associated with this result.
        Specified by:
        setMatchedDn in interface ExtendedResult
        Specified by:
        setMatchedDn in interface Result
        Parameters:
        dn - The matched DN associated, which may be empty or null indicating that none was provided.
        Returns:
        This result.

      • setMatchedDn

        GenericExtendedResult setMatchedDn​(Dn dn)
        Description copied from interface: Result
        Sets the matched DN associated with this result.
        Specified by:
        setMatchedDn in interface ExtendedResult
        Specified by:
        setMatchedDn in interface Result
        Parameters:
        dn - The matched DN associated, which may be empty or null indicating that none was provided.
        Returns:
        This result.

      • setOid

        GenericExtendedResult setOid​(String oid)
        Sets the numeric OID, if any, associated with this extended result.
        Parameters:
        oid - The numeric OID associated with this extended result, or null if there is no value.
        Returns:
        This generic extended result.
        Throws:
        UnsupportedOperationException - If this generic extended result does not permit the result name to be set.

      • setValue

        GenericExtendedResult setValue​(Object value)
        Sets the value, if any, associated with this extended result. Its format is defined by the specification of this extended result.

        If value is not an instance of ByteString then it will be converted using the ByteString.valueOfObject(Object) method.

        Parameters:
        value - The value associated with this extended result, or null if there is no value.
        Returns:
        This generic extended result.
        Throws:
        UnsupportedOperationException - If this generic extended result does not permit the result value to be set.