Package org.forgerock.opendj.ldap.controls

Class ProxiedAuthV1RequestControl

  • All Implemented Interfaces:
    Control
    public final class ProxiedAuthV1RequestControl
extends Object
implements Control
    The proxy authorization v1 request control as defined in draft-weltman-ldapv3-proxy-04. This control allows a user to request that an operation be performed using the authorization of another user. The target user is specified as a DN in the control value, which distinguishes it from later versions of the control (which used a different OID) in which the target user was specified using an authorization ID.

    This control implementation is based on version 1 of the proxied authorization control as defined in early versions of draft-weltman-ldapv3-proxy (this implementation is based on the "-04" revision) and is intended for use in legacy applications. New applications should use the v2 version of this control in preference.

    See Also:
    draft-weltman-ldapv3-proxy-04 - LDAP Proxied Authorization Control

    • Method Detail

      • newControl

        public static ProxiedAuthV1RequestControl newControl​(Dn authorizationName)
        Creates a new proxy authorization v1 request control with the provided authorization name.
        Parameters:
        authorizationName - The distinguished name of the user whose authorization is to be used when performing the operation.
        Returns:
        The new control.
        Throws:
        NullPointerException - If authorizationName was null.

      • newControl

        public static ProxiedAuthV1RequestControl newControl​(String authorizationName)
        Creates a new proxy authorization v1 request control with the provided authorization name decoded using the default schema.
        Parameters:
        authorizationName - The distinguished name of the user whose authorization is to be used when performing the operation.
        Returns:
        The new control.
        Throws:
        LocalizedIllegalArgumentException - If authorizationName is not a valid LDAP string representation of a DN.
        NullPointerException - If authorizationName was null.

      • getAuthorizationDnName

        public Dn getAuthorizationDnName()
        Returns the distinguished name of the user whose authorization is to be used when performing the operation.
        Returns:
        The distinguished name of the user whose authorization is to be used when performing the operation.

      • getOid

        public String getOid()
        Description copied from interface: Control
        Returns the numeric OID associated with this control.
        Specified by:
        getOid in interface Control
        Returns:
        The numeric OID associated with this control.

      • getValue

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

      • hasValue

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

      • isCritical

        public boolean isCritical()
        Description copied from interface: Control
        Returns true if it is unacceptable to perform the operation without applying the semantics of this control.

        The criticality field only has meaning in controls attached to request messages (except UnbindRequest). For controls attached to response messages and the UnbindRequest, the criticality field SHOULD be false, and MUST be ignored by the receiving protocol peer. A value of true indicates that it is unacceptable to perform the operation without applying the semantics of the control.

        Specified by:
        isCritical in interface Control
        Returns:
        true if this control must be processed by the Directory Server, or false if it can be ignored.