com.unboundid.ldap.sdk.unboundidds.controls.EffectiveRightsEntry 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-2022 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2008-2022 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2008-2022 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.Collections;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.logging.Level;
import com.unboundid.ldap.sdk.Attribute;
import com.unboundid.ldap.sdk.Entry;
import com.unboundid.ldap.sdk.ReadOnlyEntry;
import com.unboundid.util.Debug;
import com.unboundid.util.DebugType;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.Validator;
/**
* This class provides a mechanism for extracting the effective rights
* information from an entry returned for a search request that included the
* get effective rights request control. In particular, it provides the ability
* to parse the values of the aclRights attributes in order to determine what
* rights the specified user may have when interacting with the entry.
*
*
* 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.
*
*
* See the {@link GetEffectiveRightsRequestControl} for an example that
* demonstrates the use of the get effective rights request control and this
* entry.
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class EffectiveRightsEntry
extends ReadOnlyEntry
{
/**
* The name of the attribute that includes the rights information.
*/
@NotNull private static final String ATTR_ACL_RIGHTS = "aclRights";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -3203127456449579174L;
// The set of entry-level rights parsed from the entry.
@Nullable private final Set entryRights;
// The set of attribute-level rights parsed from the entry, mapped from the
// name of the attribute to the set of the corresponding attribute rights.
@Nullable private final Map> attributeRights;
/**
* Creates a new get effective rights entry from the provided entry.
*
* @param entry The entry to use to create this get effective rights entry.
* It must not be {@code null}.
*/
public EffectiveRightsEntry(@NotNull final Entry entry)
{
super(entry);
final HashSet options = StaticUtils.hashSetOf("entryLevel");
List attrList =
getAttributesWithOptions(ATTR_ACL_RIGHTS, options);
if ((attrList == null) || attrList.isEmpty())
{
if (Debug.debugEnabled(DebugType.LDAP))
{
Debug.debug(Level.WARNING, DebugType.LDAP,
"No entry-level aclRights information contained in entry " +
entry.getDN());
}
entryRights = null;
}
else
{
entryRights = Collections.unmodifiableSet(parseEntryRights(attrList));
}
options.clear();
options.add("attributeLevel");
attrList = getAttributesWithOptions(ATTR_ACL_RIGHTS, options);
if ((attrList == null) || attrList.isEmpty())
{
if (Debug.debugEnabled(DebugType.LDAP))
{
Debug.debug(Level.WARNING, DebugType.LDAP,
"No attribute-level aclRights information contained in entry " +
entry.getDN());
}
attributeRights = null;
}
else
{
final HashMap> attrRightsMap =
new HashMap<>(StaticUtils.computeMapCapacity(attrList.size()));
for (final Attribute a : attrList)
{
final Set attrOptions = a.getOptions();
String attrName = null;
for (final String s : attrOptions)
{
if (! s.equalsIgnoreCase("attributeLevel"))
{
attrName = s;
}
}
if (attrName == null)
{
if (Debug.debugEnabled(DebugType.LDAP))
{
Debug.debug(Level.WARNING, DebugType.LDAP,
"Unable to determine the target attribute name from " +
a.getName());
}
}
else
{
final String lowerName = StaticUtils.toLowerCase(attrName);
final Set rights = parseAttributeRights(a);
attrRightsMap.put(lowerName, rights);
}
}
attributeRights = Collections.unmodifiableMap(attrRightsMap);
}
}
/**
* Parses the entry rights information from the entry.
*
* @param attrList The list of attributes to be parsed.
*
* @return The set of entry rights parsed from the entry.
*/
@NotNull()
private static Set parseEntryRights(
@NotNull final List attrList)
{
final EnumSet entryRightsSet = EnumSet.noneOf(EntryRight.class);
for (final Attribute a : attrList)
{
for (final String value : a.getValues())
{
final StringTokenizer tokenizer = new StringTokenizer(value, ", ");
while (tokenizer.hasMoreTokens())
{
final String token = tokenizer.nextToken();
if (token.endsWith(":1"))
{
final String rightName = token.substring(0, token.length()-2);
final EntryRight r = EntryRight.forName(rightName);
if (r == null)
{
if (Debug.debugEnabled(DebugType.LDAP))
{
Debug.debug(Level.WARNING, DebugType.LDAP,
"Unrecognized entry right " + rightName);
}
}
else
{
entryRightsSet.add(r);
}
}
}
}
}
return entryRightsSet;
}
/**
* Parses the attribute rights information from the provided attribute.
*
* @param a The attribute to be parsed.
*
* @return The set of attribute rights parsed from the provided attribute.
*/
@NotNull()
private static Set parseAttributeRights(
@NotNull final Attribute a)
{
final EnumSet rightsSet =
EnumSet.noneOf(AttributeRight.class);
for (final String value : a.getValues())
{
final StringTokenizer tokenizer = new StringTokenizer(value, ", ");
while (tokenizer.hasMoreTokens())
{
final String token = tokenizer.nextToken();
if (token.endsWith(":1"))
{
final String rightName = token.substring(0, token.length()-2);
final AttributeRight r = AttributeRight.forName(rightName);
if (r == null)
{
if (Debug.debugEnabled(DebugType.LDAP))
{
Debug.debug(Level.WARNING, DebugType.LDAP,
"Unrecognized attribute right " + rightName);
}
}
else
{
rightsSet.add(r);
}
}
}
}
return rightsSet;
}
/**
* Indicates whether any access control rights information was contained in
* the entry.
*
* @return {@code true} if access control rights information was contained in
* the entry, or {@code false} if not.
*/
public boolean rightsInformationAvailable()
{
return ((entryRights != null) || (attributeRights != null));
}
/**
* Retrieves the set of entry-level rights parsed from the entry.
*
* @return The set of entry-level rights parsed from the entry, or
* {@code null} if the entry did not have any entry-level rights
* information.
*/
@Nullable()
public Set getEntryRights()
{
return entryRights;
}
/**
* Indicates whether the specified entry right is granted for this entry.
*
* @param entryRight The entry right for which to make the determination.
* It must not be {@code null}.
*
* @return {@code true} if the entry included entry-level rights information
* and the specified entry right is granted, or {@code false} if not.
*/
public boolean hasEntryRight(@NotNull final EntryRight entryRight)
{
Validator.ensureNotNull(entryRight);
return ((entryRights != null) && entryRights.contains(entryRight));
}
/**
* Retrieves the set of attribute-level rights parsed from the entry, mapped
* from attribute name (in all lowercase characters) to the set of
* attribute-level rights for that attribute.
*
* @return The set of attribute-level rights parsed from the entry, or
* {@code null} if the entry did not have any attribute-level rights
* information.
*/
@Nullable()
public Map> getAttributeRights()
{
return attributeRights;
}
/**
* Retrieves the set of attribute-level rights parsed from the entry for the
* specified attribute.
*
* @param attributeName The name of the attribute for which to retrieve the
* attribute-level rights. It must not be
* {@code null}.
*
* @return The set of attribute-level rights for the specified attribute, or
* {@code null} if the entry did not include any attribute-level
* rights information for the specified attribute.
*/
@Nullable()
public Set getAttributeRights(
@NotNull final String attributeName)
{
Validator.ensureNotNull(attributeName);
if (attributeRights == null)
{
return null;
}
return attributeRights.get(StaticUtils.toLowerCase(attributeName));
}
/**
* Indicates whether the specified attribute right is granted for the
* specified attribute in this entry.
*
* @param attributeRight The attribute right for which to make the
* determination. It must not be {@code null}.
* @param attributeName The name of the attribute for which to make the
* determination. It must not be {@code null}.
*
* @return {@code true} if the entry included attribute-level rights
* information for the specified attribute and the indicated right is
* granted, or {@code false} if not.
*/
public boolean hasAttributeRight(@NotNull final AttributeRight attributeRight,
@NotNull final String attributeName)
{
Validator.ensureNotNull(attributeName, attributeRight);
final Set attrRights = getAttributeRights(attributeName);
return ((attrRights != null) && attrRights.contains(attributeRight));
}
}