@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetAuthorizationEntryResponseControl extends Control implements DecodeableControl
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only
supported for use against Ping Identity, UnboundID, and
Nokia/Alcatel-Lucent 8661 server products. These classes provide support
for proprietary functionality or for external specifications that are not
considered stable or mature enough to be guaranteed to work in an
interoperable way with other types of LDAP servers.
GetAuthorizationEntryResponse ::= SEQUENCE { isAuthenticated [0] BOOLEAN, identitiesMatch [1] BOOLEAN, authNEntry [2] AuthEntry OPTIONAL, authZEntry [3] AuthEntry OPTIONAL } AuthEntry ::= SEQUENCE { authID [0] AuthzId OPTIONAL, authDN [1] LDAPDN, attributes [2] PartialAttributeList }
GetAuthorizationEntryRequestControl
class for more information and an example demonstrating the use of these
controls.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
GET_AUTHORIZATION_ENTRY_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.5.6) for the get authorization entry response
control.
|
Constructor and Description |
---|
GetAuthorizationEntryResponseControl(boolean isAuthenticated,
boolean identitiesMatch,
java.lang.String authNID,
ReadOnlyEntry authNEntry,
java.lang.String authZID,
ReadOnlyEntry authZEntry)
Creates a new get authorization entry response control with the provided
information.
|
GetAuthorizationEntryResponseControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new get authorization entry response control with the provided
information.
|
Modifier and Type | Method and Description |
---|---|
GetAuthorizationEntryResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided
information.
|
static GetAuthorizationEntryResponseControl |
get(BindResult result)
Extracts a get authorization entry response control from the provided
result.
|
ReadOnlyEntry |
getAuthNEntry()
Retrieves the entry for the user specified as the authentication identity,
if it is available.
|
java.lang.String |
getAuthNID()
Retrieves the identifier that may be used to reference the authentication
identity in the directory server, if it is available.
|
ReadOnlyEntry |
getAuthZEntry()
Retrieves the entry for the user specified as the authorization identity,
if it is available.
|
java.lang.String |
getAuthZID()
Retrieves the identifier that may be used to reference the authorization
identity in the directory server, if it is available.
|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available.
|
boolean |
identitiesMatch()
Indicates whether the authentication identity and the authorization
identity reference the same user.
|
boolean |
isAuthenticated()
Indicates whether the client is authenticated.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided
buffer.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String GET_AUTHORIZATION_ENTRY_RESPONSE_OID
public GetAuthorizationEntryResponseControl(boolean isAuthenticated, boolean identitiesMatch, @Nullable java.lang.String authNID, @Nullable ReadOnlyEntry authNEntry, @Nullable java.lang.String authZID, @Nullable ReadOnlyEntry authZEntry)
isAuthenticated
- Indicates whether the client is authenticated.identitiesMatch
- Indicates whether the authentication identity is
the same as the authorization identity.authNID
- The string that may be used to reference the
authentication identity. It may be null
if information about the authentication identity
is not to be included, or if the identifier should
be derived from the DN.authNEntry
- The entry for the authentication identity. It may
be null
if the information about the
authentication identity is not to be included.authZID
- The string that may be used to reference the
authorization identity. It may be null
if information about the authentication identity
is not to be included, if the identifier should
be derived from the DN, or if the authentication
and authorization identities are the same.authZEntry
- The entry for the authentication identity. It may
be null
if the information about the
authentication identity is not to be included, or
if the authentication and authorization identities
are the same.public GetAuthorizationEntryResponseControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.LDAPException
- If the provided control cannot be decoded as a get
authorization entry response control.@NotNull public GetAuthorizationEntryResponseControl decodeControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.@Nullable public static GetAuthorizationEntryResponseControl get(@NotNull BindResult result) throws LDAPException
result
- The result from which to retrieve the get authorization
entry response control.null
if the result did not contain a
get authorization entry response control.LDAPException
- If a problem is encountered while attempting to
decode the get authorization entry response control
contained in the provided result.public boolean isAuthenticated()
true
if the client is authenticated, or false
if
not.public boolean identitiesMatch()
true
if both the authentication identity and the
authorization identity reference the same user, or false
if not.@Nullable public java.lang.String getAuthNID()
null
if it is not
available.@Nullable public ReadOnlyEntry getAuthNEntry()
null
if it is not available.@Nullable public java.lang.String getAuthZID()
null
if it is not
available.@Nullable public ReadOnlyEntry getAuthZEntry()
null
if it is not available.@NotNull public java.lang.String getControlName()
getControlName
in class Control