uk.ac.bath.bucs.idm.ldap

Class AttributeUtils

java.lang.Object

uk.ac.bath.bucs.idm.ldap.AttributeUtils

public class AttributeUtils
extends Object

This class contains various static methods for working with LDAP attributes. These methods are mostly intended for internal use in LdapService, but some of them are more generally useful.

Author:

Tim Barrett

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALTERNATE_ATTRIBUTE_POSTFIX The text appended to attribute names to set alternate values - currently ;x-alternate.

Method Summary

Modifier and Type	Method and Description
static void	addAlternateAttribute(Map<String,Attribute> map, String name, List<FlaggableString> values) Adds BasicAttributes for both regular and alternate versions of the specified attribute name to the provided Map, or sets appropriate nulls if null is passed or no data of the given type is supplied.
static void	addAttribute(Map<String,Attribute> map, String name, Collection<String> values) Adds a BasicAttribute for the specified attribute name and values to the provided Map, or adds a null if null is passed or no values are supplied.
static void	addAttribute(Map<String,Attribute> map, String name, org.threeten.bp.LocalDate value) Adds a BasicAttribute for the specified attribute name and value to the provided Map, converting the date into a textual format, or adds a null if null is passed.
static void	addAttribute(Map<String,Attribute> map, String name, Map<String,String> values, String separator) Adds a BasicAttribute for the specified attribute name and values to the provided Map, or adds a null if null is passed or no values are supplied.
static void	addAttribute(Map<String,Attribute> map, String name, String value) Adds a BasicAttribute for the specified attribute name and value to the provided Map, or adds a null if null is passed.
static void	addUniqueAttribute(Map<String,Attribute> map, String name, Map<String,String> values) Adds a BasicAttribute for the specified attribute name and values to the provided Map, or adds a null if null is passed or no values are supplied.
static List<FlaggableString>	extractAlternateAttribute(Attributes attribs, String name) Extracts the values for attributes with the supplied name, and the supplied name with ALTERNATE_ATTRIBUTE_POSTFIX appended, from the supplied Attributes object into a list of FlaggableStrings.
static org.threeten.bp.LocalDate	extractDateAttribute(Attributes attribs, String name, String dn) Extracts the single value for the attribute with the supplied name from the supplied Attributes object and converts it to a LocalDate, or returns null if the attribute isn't set.
static List<String>	extractListAttribute(Attributes attribs, String name) Extracts the values for the attribute with the supplied name from the supplied Attributes object into a List of Strings.
static Map<String,String>	extractMapAttribute(Attributes attribs, String name, String regex, String dn) Extracts the values for attribute with the supplied name from the supplied Attributes object into a @{code Map<String, String>}, using the supplied regular expression.
static Set<String>	extractSetAttribute(Attributes attribs, String name) Extracts the values for the attribute with the supplied name from the supplied Attributes object into a Set of Strings.
static String	extractSingleValueAttribute(Attributes attribs, String name) Extracts the single value for the attribute with the supplied name from the supplied Attributes object, or null if it isn't set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALTERNATE_ATTRIBUTE_POSTFIX

public static final String ALTERNATE_ATTRIBUTE_POSTFIX

The text appended to attribute names to set alternate values - currently ;x-alternate.

See Also:

Constant Field Values

Method Detail

addAttribute

public static void addAttribute(Map<String,Attribute> map,
                                String name,
                                String value)

Adds a BasicAttribute for the specified attribute name and value to the provided Map, or adds a null if null is passed.

Parameters:

map - the map from attribute names to attribute objects to add to

name - the name of the attribute to add

value - the String to add, or null to add a null

addAttribute

public static void addAttribute(Map<String,Attribute> map,
                                String name,
                                org.threeten.bp.LocalDate value)

Adds a BasicAttribute for the specified attribute name and value to the provided Map, converting the date into a textual format, or adds a null if null is passed.

Parameters:

map - the Map from attribute names to attribute objects to add to

name - the name of the attribute to add

value - the LocalDate to add, or null to add a null

addAttribute

public static void addAttribute(Map<String,Attribute> map,
                                String name,
                                Collection<String> values)

Adds a BasicAttribute for the specified attribute name and values to the provided Map, or adds a null if null is passed or no values are supplied.

Parameters:

map - the map from attribute names to attribute objects to add to

name - the name of the attribute to add

values - the collection of String values to add, or null to add a null

addAttribute

public static void addAttribute(Map<String,Attribute> map,
                                String name,
                                Map<String,String> values,
                                String separator)

Adds a BasicAttribute for the specified attribute name and values to the provided Map, or adds a null if null is passed or no values are supplied. The map of values provided is converted into set set of values by joining the key-value pairs with the supplied separator.

Parameters:

map - the map from attribute names to attribute objects to add to

name - the name of the attribute to add

values - the @{code Map<String, String>} to add, or null to add a null

separator - The separator to use when combining keys and values

addAlternateAttribute

public static void addAlternateAttribute(Map<String,Attribute> map,
                                         String name,
                                         List<FlaggableString> values)

Adds BasicAttributes for both regular and alternate versions of the specified attribute name to the provided Map, or sets appropriate nulls if null is passed or no data of the given type is supplied.

Parameters:

map - the map from attribute names to attribute objects to add to

name - the name of the attribute to add

values - a list of values to add, or null to add nulls

addUniqueAttribute

public static void addUniqueAttribute(Map<String,Attribute> map,
                                      String name,
                                      Map<String,String> values)

Adds a BasicAttribute for the specified attribute name and values to the provided Map, or adds a null if null is passed or no values are supplied. The values are the values from the supplied map values.

The values map must be populated by calling toUpper() on each String you wish to add and using that as the key, the String to be written forming the value.

Parameters:

map - the map from attribute names to attribute objects to add to

name - the name of the attribute to add

values - the map with the values to add as both the values and, in upper case, the keys, or null to add a null

extractSingleValueAttribute

public static String extractSingleValueAttribute(Attributes attribs,
                                                 String name)
                                          throws NamingException

Extracts the single value for the attribute with the supplied name from the supplied Attributes object, or null if it isn't set.

Parameters:

attribs - the Attributes object containing the data to extract

name - the name of the attribute

Returns:

the extracted data, or null if it isn't set

Throws:

NamingException - in case of error

extractDateAttribute

public static org.threeten.bp.LocalDate extractDateAttribute(Attributes attribs,
                                                             String name,
                                                             String dn)
                                                      throws NamingException,
                                                             LdapDataException

Extracts the single value for the attribute with the supplied name from the supplied Attributes object and converts it to a LocalDate, or returns null if the attribute isn't set.

Parameters:

attribs - the Attributes object containing the data to extract

name - the name of the attribute

dn - the Distinguished Name of the record, for use reporting errors

Returns:

the extracted date, or null if it isn't set

Throws:

NamingException - in case of LDAP error

LdapDataException - if the format is incorrect

extractListAttribute

public static List<String> extractListAttribute(Attributes attribs,
                                                String name)
                                         throws NamingException

Extracts the values for the attribute with the supplied name from the supplied Attributes object into a List of Strings.

Parameters:

attribs - the Attributes object containing the data to extract

name - the name of the attribute

Returns:

a List of Strings with the extracted data, in no particular order, or null if there are no values

Throws:

NamingException - in case of error

extractSetAttribute

public static Set<String> extractSetAttribute(Attributes attribs,
                                              String name)
                                       throws NamingException

Extracts the values for the attribute with the supplied name from the supplied Attributes object into a Set of Strings.

Parameters:

attribs - the Attributes object containing the data to extract

name - the name of the attribute

Returns:

a Set of Strings with the extracted data, or null if there are no values

Throws:

NamingException - in case of error

extractMapAttribute

public static Map<String,String> extractMapAttribute(Attributes attribs,
                                                     String name,
                                                     String regex,
                                                     String dn)
                                              throws NamingException,
                                                     LdapDataException

Extracts the values for attribute with the supplied name from the supplied Attributes object into a @{code Map<String, String>}, using the supplied regular expression.

Parameters:

attribs - the Attributes object containing the data to extract

name - the name of the attribute

regex - the regular expression to split key and value from the attribute values

dn - the Distinguished Name of the record, for use reporting errors

Returns:

a @{code Map<String, String>} with the extracted data, or null if there are no values

Throws:

NamingException - in case of LDAP-related error

LdapDataException - in case of data format issues

extractAlternateAttribute

public static List<FlaggableString> extractAlternateAttribute(Attributes attribs,
                                                              String name)
                                                       throws NamingException

Extracts the values for attributes with the supplied name, and the supplied name with ALTERNATE_ATTRIBUTE_POSTFIX appended, from the supplied Attributes object into a list of FlaggableStrings.

Parameters:

attribs - the Attributes object containing the data to extract

name - the name of the basic attribute, before appending the option

Returns:

a List<FlaggableString> with the extracted data, in no particular order, or null if there are no values

Throws:

NamingException - in case of error