com.unboundid.ldap.sdk.unboundidds.controls.GetAuthorizationEntryRequestControl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2008-2018 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2015-2018 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.unboundidds.controls;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import com.unboundid.asn1.ASN1Boolean;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.util.Debug;
import com.unboundid.util.NotMutable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import static com.unboundid.ldap.sdk.unboundidds.controls.ControlMessages.*;
/**
* This class provides an implementation of an LDAP control that can be included
* in a bind request to request that the Directory Server return the
* authentication and authorization entries for the user that authenticated.
*
*
* NOTE: This class, and other classes within the
* {@code 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.
*
*
* The value of this control may be absent, but if it is present then will be
* encoded as follows:
*
* GetAuthorizationEntryRequest ::= SEQUENCE {
* includeAuthNEntry [0] BOOLEAN DEFAULT TRUE,
* includeAuthZEntry [1] BOOLEAN DEFAULT TRUE,
* attributes [2] AttributeSelection OPTIONAL }
*
*
* Example
* The following example demonstrates the process for processing a bind
* operation using the get authorization entry request control to return all
* user attributes in both the authentication and authorization entries:
*
* 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();
* }
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class GetAuthorizationEntryRequestControl
extends Control
{
/**
* The OID (1.3.6.1.4.1.30221.2.5.6) for the get authorization entry request
* control.
*/
public static final String GET_AUTHORIZATION_ENTRY_REQUEST_OID =
"1.3.6.1.4.1.30221.2.5.6";
/**
* The BER type for the {@code includeAuthNEntry} element.
*/
private static final byte TYPE_INCLUDE_AUTHN_ENTRY = (byte) 0x80;
/**
* The BER type for the {@code includeAuthZEntry} element.
*/
private static final byte TYPE_INCLUDE_AUTHZ_ENTRY = (byte) 0x81;
/**
* The BER type for the {@code attributes} element.
*/
private static final byte TYPE_ATTRIBUTES = (byte) 0xA2;
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -5540345171260624216L;
// Indicates whether to include the authentication entry in the response.
private final boolean includeAuthNEntry;
// Indicates whether to include the authorization entry in the response.
private final boolean includeAuthZEntry;
// The list of attributes to include in entries that are returned.
private final List attributes;
/**
* Creates a new get authorization entry request control that will request all
* user attributes in both the authentication and authorization entries. It
* will not be marked critical.
*/
public GetAuthorizationEntryRequestControl()
{
this(false, true, true, (List) null);
}
/**
* Creates a new get authorization entry request control with the provided
* information.
*
* @param includeAuthNEntry Indicates whether to include the authentication
* entry in the response.
* @param includeAuthZEntry Indicates whether to include the authorization
* entry in the response.
* @param attributes The attributes to include in the entries in the
* response. It may be empty or {@code null} to
* request all user attributes.
*/
public GetAuthorizationEntryRequestControl(final boolean includeAuthNEntry,
final boolean includeAuthZEntry,
final String... attributes)
{
this(false, includeAuthNEntry, includeAuthZEntry,
(attributes == null) ? null : Arrays.asList(attributes));
}
/**
* Creates a new get authorization entry request control with the provided
* information.
*
* @param includeAuthNEntry Indicates whether to include the authentication
* entry in the response.
* @param includeAuthZEntry Indicates whether to include the authorization
* entry in the response.
* @param attributes The attributes to include in the entries in the
* response. It may be empty or {@code null} to
* request all user attributes.
*/
public GetAuthorizationEntryRequestControl(final boolean includeAuthNEntry,
final boolean includeAuthZEntry,
final List attributes)
{
this(false, includeAuthNEntry, includeAuthZEntry, attributes);
}
/**
* Creates a new get authorization entry request control with the provided
* information.
*
* @param isCritical Indicates whether the control should be marked
* critical.
* @param includeAuthNEntry Indicates whether to include the authentication
* entry in the response.
* @param includeAuthZEntry Indicates whether to include the authorization
* entry in the response.
* @param attributes The attributes to include in the entries in the
* response. It may be empty or {@code null} to
* request all user attributes.
*/
public GetAuthorizationEntryRequestControl(final boolean isCritical,
final boolean includeAuthNEntry,
final boolean includeAuthZEntry,
final String... attributes)
{
this(isCritical, includeAuthNEntry, includeAuthZEntry,
(attributes == null) ? null : Arrays.asList(attributes));
}
/**
* Creates a new get authorization entry request control with the provided
* information.
*
* @param isCritical Indicates whether the control should be marked
* critical.
* @param includeAuthNEntry Indicates whether to include the authentication
* entry in the response.
* @param includeAuthZEntry Indicates whether to include the authorization
* entry in the response.
* @param attributes The attributes to include in the entries in the
* response. It may be empty or {@code null} to
* request all user attributes.
*/
public GetAuthorizationEntryRequestControl(final boolean isCritical,
final boolean includeAuthNEntry,
final boolean includeAuthZEntry,
final List attributes)
{
super(GET_AUTHORIZATION_ENTRY_REQUEST_OID, isCritical,
encodeValue(includeAuthNEntry, includeAuthZEntry, attributes));
this.includeAuthNEntry = includeAuthNEntry;
this.includeAuthZEntry = includeAuthZEntry;
if ((attributes == null) || attributes.isEmpty())
{
this.attributes = Collections.emptyList();
}
else
{
this.attributes =
Collections.unmodifiableList(new ArrayList<>(attributes));
}
}
/**
* Creates a new get authorization entry request control which is decoded from
* the provided generic control.
*
* @param control The generic control to decode as a get authorization entry
* request control.
*
* @throws LDAPException If the provided control cannot be decoded as a get
* authorization entry request control.
*/
public GetAuthorizationEntryRequestControl(final Control control)
throws LDAPException
{
super(control);
final ASN1OctetString value = control.getValue();
if (value == null)
{
includeAuthNEntry = true;
includeAuthZEntry = true;
attributes = Collections.emptyList();
return;
}
try
{
final ArrayList attrs = new ArrayList<>(20);
boolean includeAuthN = true;
boolean includeAuthZ = true;
final ASN1Element element = ASN1Element.decode(value.getValue());
for (final ASN1Element e :
ASN1Sequence.decodeAsSequence(element).elements())
{
switch (e.getType())
{
case TYPE_INCLUDE_AUTHN_ENTRY:
includeAuthN = ASN1Boolean.decodeAsBoolean(e).booleanValue();
break;
case TYPE_INCLUDE_AUTHZ_ENTRY:
includeAuthZ = ASN1Boolean.decodeAsBoolean(e).booleanValue();
break;
case TYPE_ATTRIBUTES:
for (final ASN1Element ae :
ASN1Sequence.decodeAsSequence(e).elements())
{
attrs.add(ASN1OctetString.decodeAsOctetString(ae).stringValue());
}
break;
default:
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GET_AUTHORIZATION_ENTRY_REQUEST_INVALID_SEQUENCE_ELEMENT.
get(StaticUtils.toHex(e.getType())));
}
}
includeAuthNEntry = includeAuthN;
includeAuthZEntry = includeAuthZ;
attributes = attrs;
}
catch (final LDAPException le)
{
throw le;
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GET_AUTHORIZATION_ENTRY_REQUEST_CANNOT_DECODE_VALUE.get(
StaticUtils.getExceptionMessage(e)),
e);
}
}
/**
* Encodes the provided information as appropriate for use as the value of
* this control.
*
* @param includeAuthNEntry Indicates whether to include the authentication
* entry in the response.
* @param includeAuthZEntry Indicates whether to include the authorization
* entry in the response.
* @param attributes The attributes to include in the entries in the
* response. It may be empty or {@code null} to
* request all user attributes.
*
* @return An ASN.1 octet string appropriately encoded for use as the control
* value, or {@code null} if no value is needed.
*/
private static ASN1OctetString encodeValue(final boolean includeAuthNEntry,
final boolean includeAuthZEntry,
final List attributes)
{
if (includeAuthNEntry && includeAuthZEntry &&
((attributes == null) || attributes.isEmpty()))
{
return null;
}
final ArrayList elements = new ArrayList<>(3);
if (! includeAuthNEntry)
{
elements.add(new ASN1Boolean(TYPE_INCLUDE_AUTHN_ENTRY, false));
}
if (! includeAuthZEntry)
{
elements.add(new ASN1Boolean(TYPE_INCLUDE_AUTHZ_ENTRY, false));
}
if ((attributes != null) && (! attributes.isEmpty()))
{
final ArrayList attrElements =
new ArrayList<>(attributes.size());
for (final String s : attributes)
{
attrElements.add(new ASN1OctetString(s));
}
elements.add(new ASN1Sequence(TYPE_ATTRIBUTES, attrElements));
}
return new ASN1OctetString(new ASN1Sequence(elements).encode());
}
/**
* Indicates whether the entry for the authenticated user should be included
* in the response control.
*
* @return {@code true} if the entry for the authenticated user should be
* included in the response control, or {@code false} if not.
*/
public boolean includeAuthNEntry()
{
return includeAuthNEntry;
}
/**
* Indicates whether the entry for the authorized user should be included
* in the response control.
*
* @return {@code true} if the entry for the authorized user should be
* included in the response control, or {@code false} if not.
*/
public boolean includeAuthZEntry()
{
return includeAuthZEntry;
}
/**
* Retrieves the attributes that will be requested for the authentication
* and/or authorization entries.
*
* @return The attributes that will be requested for the authentication
* and/or authorization entries, or an empty list if all user
* attributes should be included.
*/
public List getAttributes()
{
return attributes;
}
/**
* {@inheritDoc}
*/
@Override()
public String getControlName()
{
return INFO_CONTROL_NAME_GET_AUTHORIZATION_ENTRY_REQUEST.get();
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(final StringBuilder buffer)
{
buffer.append("GetAuthorizationEntryRequestControl(isCritical=");
buffer.append(isCritical());
buffer.append(", includeAuthNEntry=");
buffer.append(includeAuthNEntry);
buffer.append(", includeAuthZEntry=");
buffer.append(includeAuthZEntry);
buffer.append(", attributes={");
final Iterator iterator = attributes.iterator();
while (iterator.hasNext())
{
buffer.append(iterator.next());
if (iterator.hasNext())
{
buffer.append(", ");
}
}
buffer.append("})");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy