@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetAuthorizationEntryRequestControl extends Control
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.
GetAuthorizationEntryRequest ::= SEQUENCE { includeAuthNEntry [0] BOOLEAN DEFAULT TRUE, includeAuthZEntry [1] BOOLEAN DEFAULT TRUE, attributes [2] AttributeSelection OPTIONAL }
ReadOnlyEntry authNEntry = null; ReadOnlyEntry authZEntry = null; BindRequest bindRequest = new SimpleBindRequest( "uid=john.doe,ou=People,dc=example,dc=com", "password", new GetAuthorizationEntryRequestControl()); BindResult bindResult = connection.bind(bindRequest); GetAuthorizationEntryResponseControl c = GetAuthorizationEntryResponseControl.get(bindResult); if (c != null) { authNEntry = c.getAuthNEntry(); authZEntry = c.getAuthZEntry(); }
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
GET_AUTHORIZATION_ENTRY_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.6) for the get authorization entry request
control.
|
Constructor and Description |
---|
GetAuthorizationEntryRequestControl()
Creates a new get authorization entry request control that will request all
user attributes in both the authentication and authorization entries.
|
GetAuthorizationEntryRequestControl(boolean isCritical,
boolean includeAuthNEntry,
boolean includeAuthZEntry,
java.util.List<java.lang.String> attributes)
Creates a new get authorization entry request control with the provided
information.
|
GetAuthorizationEntryRequestControl(boolean isCritical,
boolean includeAuthNEntry,
boolean includeAuthZEntry,
java.lang.String... attributes)
Creates a new get authorization entry request control with the provided
information.
|
GetAuthorizationEntryRequestControl(boolean includeAuthNEntry,
boolean includeAuthZEntry,
java.util.List<java.lang.String> attributes)
Creates a new get authorization entry request control with the provided
information.
|
GetAuthorizationEntryRequestControl(boolean includeAuthNEntry,
boolean includeAuthZEntry,
java.lang.String... attributes)
Creates a new get authorization entry request control with the provided
information.
|
GetAuthorizationEntryRequestControl(Control control)
Creates a new get authorization entry request control which is decoded from
the provided generic control.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.String> |
getAttributes()
Retrieves the attributes that will be requested for the authentication
and/or authorization entries.
|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available.
|
boolean |
includeAuthNEntry()
Indicates whether the entry for the authenticated user should be included
in the response control.
|
boolean |
includeAuthZEntry()
Indicates whether the entry for the authorized user should be included
in the response control.
|
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_REQUEST_OID
public GetAuthorizationEntryRequestControl()
public GetAuthorizationEntryRequestControl(boolean includeAuthNEntry, boolean includeAuthZEntry, @Nullable java.lang.String... attributes)
includeAuthNEntry
- Indicates whether to include the authentication
entry in the response.includeAuthZEntry
- Indicates whether to include the authorization
entry in the response.attributes
- The attributes to include in the entries in the
response. It may be empty or null
to
request all user attributes.public GetAuthorizationEntryRequestControl(boolean includeAuthNEntry, boolean includeAuthZEntry, @Nullable java.util.List<java.lang.String> attributes)
includeAuthNEntry
- Indicates whether to include the authentication
entry in the response.includeAuthZEntry
- Indicates whether to include the authorization
entry in the response.attributes
- The attributes to include in the entries in the
response. It may be empty or null
to
request all user attributes.public GetAuthorizationEntryRequestControl(boolean isCritical, boolean includeAuthNEntry, boolean includeAuthZEntry, @Nullable java.lang.String... attributes)
isCritical
- Indicates whether the control should be marked
critical.includeAuthNEntry
- Indicates whether to include the authentication
entry in the response.includeAuthZEntry
- Indicates whether to include the authorization
entry in the response.attributes
- The attributes to include in the entries in the
response. It may be empty or null
to
request all user attributes.public GetAuthorizationEntryRequestControl(boolean isCritical, boolean includeAuthNEntry, boolean includeAuthZEntry, @Nullable java.util.List<java.lang.String> attributes)
isCritical
- Indicates whether the control should be marked
critical.includeAuthNEntry
- Indicates whether to include the authentication
entry in the response.includeAuthZEntry
- Indicates whether to include the authorization
entry in the response.attributes
- The attributes to include in the entries in the
response. It may be empty or null
to
request all user attributes.public GetAuthorizationEntryRequestControl(@NotNull Control control) throws LDAPException
control
- The generic control to decode as a get authorization entry
request control.LDAPException
- If the provided control cannot be decoded as a get
authorization entry request control.public boolean includeAuthNEntry()
true
if the entry for the authenticated user should be
included in the response control, or false
if not.public boolean includeAuthZEntry()
true
if the entry for the authorized user should be
included in the response control, or false
if not.@NotNull public java.util.List<java.lang.String> getAttributes()
@NotNull public java.lang.String getControlName()
getControlName
in class Control