Package org.ldaptive
Class LdapAttribute
java.lang.Object
org.ldaptive.LdapAttribute
- Direct Known Subclasses:
UnicodePwdAttribute
LDAP attribute defined as:
Attribute ::= PartialAttribute(WITH COMPONENTS { ..., vals (SIZE(1..MAX))})
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Attribute name.private Set
<ByteBuffer> Attribute values.private boolean
Whether this attribute is binary and string representations should be base64 encoded.private static final String[]
List of custom binary attribute names.private static final String[]
List of attribute names known to use binary syntax.private static final int
hash code seed. -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.LdapAttribute
(String type) Creates a new attribute.LdapAttribute
(String type, byte[]... value) Creates a new attribute.LdapAttribute
(String type, String... value) Creates a new attribute. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addBinaryValues
(byte[]... value) Adds the supplied byte array as a value for this attribute.void
addBinaryValues
(Collection<byte[]> values) Adds all the byte arrays in the supplied collection as values for this attribute.void
addBufferValues
(ByteBuffer... values) Adds all the buffers in the supplied collection as values for this attribute.void
addBufferValues
(Collection<ByteBuffer> values) Adds all the buffers in the supplied collection as values for this attribute.void
addStringValues
(String... value) Adds the supplied string as a value for this attribute.void
addStringValues
(Collection<String> values) Adds all the strings in the supplied collection as values for this attribute.<T> void
addValues
(Function<T, byte[]> func, Collection<T> values) Adds all the values in the supplied collection for this attribute by encoding them with the supplied function.<T> void
Adds the supplied values for this attribute by encoding them with the supplied function.static LdapAttribute.Builder
builder()
Creates a builder for this class.void
clear()
Removes all the values in this ldap attribute.void
configureBinary
(String... attrNames) Checks whether attrNames matches the name of this attribute.boolean
static String
escapeValue
(String value) Deprecated.byte[]
Returns a single byte array value of this attribute.Collection
<byte[]> Returns the values of this attribute as byte arrays.getName()
Returns the attribute description with options.getName
(boolean withOptions) Returns the attribute description with or without options.Returns any options that may exist on the attribute description.Returns a single string value of this attribute.Returns the values of this attribute as strings.<T> T
Returns a single decoded value of this attribute.<T> Collection
<T> Returns the values of this attribute decoded by the supplied function.int
hashCode()
boolean
isBinary()
Returns whether this ldap attribute is binary.void
removeBinaryValues
(byte[]... value) Removes the supplied byte array as a value from this attribute.void
removeBinaryValues
(Collection<byte[]> values) Removes all the byte arrays in the supplied collection as values from this attribute.void
removeBufferValues
(ByteBuffer... values) Removes all the buffers in the supplied collection as values from this attribute.void
removeBufferValues
(Collection<ByteBuffer> values) Removes all the buffers in the supplied collection as values from this attribute.void
removeStringValues
(String... value) Removes the supplied string as a value from this attribute.void
removeStringValues
(Collection<String> values) Removes all the strings in the supplied collection as values from this attribute.void
setBinary
(boolean b) Sets whether this ldap attribute is binary.void
Sets the name.int
size()
Returns the number of values in this ldap attribute.static LdapAttribute
sort
(LdapAttribute la) Returns a new attribute whose values are sorted.toString()
-
Field Details
-
HASH_CODE_SEED
private static final int HASH_CODE_SEEDhash code seed.- See Also:
-
DEFAULT_BINARY_ATTRIBUTES
List of attribute names known to use binary syntax. -
BINARY_ATTRIBUTES
List of custom binary attribute names. -
attributeName
Attribute name. -
attributeValues
Attribute values. -
binary
private boolean binaryWhether this attribute is binary and string representations should be base64 encoded.
-
-
Constructor Details
-
LdapAttribute
public LdapAttribute()Default constructor. -
LdapAttribute
Creates a new attribute.- Parameters:
type
- attribute description
-
LdapAttribute
Creates a new attribute.- Parameters:
type
- attribute descriptionvalue
- attribute values
-
LdapAttribute
Creates a new attribute.- Parameters:
type
- attribute descriptionvalue
- attribute values
-
-
Method Details
-
setName
Sets the name. This method has the side effect of setting this attribute as binary if the name has an option of 'binary' or the name matches one ofBINARY_ATTRIBUTES
.- Parameters:
type
- attribute name
-
isBinary
public boolean isBinary()Returns whether this ldap attribute is binary.- Returns:
- whether this ldap attribute is binary
-
setBinary
public void setBinary(boolean b) Sets whether this ldap attribute is binary.- Parameters:
b
- whether this ldap attribute is binary
-
configureBinary
Checks whether attrNames matches the name of this attribute. If a match is found this attribute is set as binary.- Parameters:
attrNames
- custom binary attribute names
-
getName
Returns the attribute description with options.- Returns:
- attribute description
-
getName
Returns the attribute description with or without options.- Parameters:
withOptions
- whether the attribute description should include options- Returns:
- attribute description
-
getOptions
Returns any options that may exist on the attribute description.- Returns:
- attribute description options
-
getBinaryValue
public byte[] getBinaryValue()Returns a single byte array value of this attribute.- Returns:
- single byte array attribute value or null if this attribute is empty
-
getBinaryValues
Returns the values of this attribute as byte arrays. The return collection cannot be modified.- Returns:
- collection of string attribute values
-
getStringValue
Returns a single string value of this attribute.- Returns:
- single string attribute value or null if this attribute is empty
-
getStringValues
Returns the values of this attribute as strings. Binary data is base64 encoded. The return collection cannot be modified.- Returns:
- collection of string attribute values
-
getValue
Returns a single decoded value of this attribute.- Type Parameters:
T
- type of decoded attribute- Parameters:
func
- to decode attribute value with- Returns:
- single decoded attribute value or null if this attribute is empty
-
getValues
Returns the values of this attribute decoded by the supplied function.- Type Parameters:
T
- type of decoded attributes- Parameters:
func
- to decode attribute values with- Returns:
- collection of decoded attribute values, null values are discarded
-
addBinaryValues
public void addBinaryValues(byte[]... value) Adds the supplied byte array as a value for this attribute.- Parameters:
value
- to add, null values are discarded
-
addBinaryValues
Adds all the byte arrays in the supplied collection as values for this attribute.- Parameters:
values
- to add, null values are discarded
-
addStringValues
Adds the supplied string as a value for this attribute.- Parameters:
value
- to add, null values are discarded
-
addStringValues
Adds all the strings in the supplied collection as values for this attribute.- Parameters:
values
- to add, null values are discarded
-
addBufferValues
Adds all the buffers in the supplied collection as values for this attribute.- Parameters:
values
- to add, null values are discarded
-
addBufferValues
Adds all the buffers in the supplied collection as values for this attribute.- Parameters:
values
- to add, null values are discarded
-
addValues
Adds the supplied values for this attribute by encoding them with the supplied function.- Type Parameters:
T
- type attribute to encode- Parameters:
func
- to encode value withvalue
- to encode and add, null values are discarded
-
addValues
Adds all the values in the supplied collection for this attribute by encoding them with the supplied function. SeeaddValues(Function, Object...)
.- Type Parameters:
T
- type attribute to encode- Parameters:
func
- to encode value withvalues
- to encode and add, null values are discarded
-
removeBinaryValues
public void removeBinaryValues(byte[]... value) Removes the supplied byte array as a value from this attribute.- Parameters:
value
- to remove, null values are discarded
-
removeBinaryValues
Removes all the byte arrays in the supplied collection as values from this attribute.- Parameters:
values
- to remove, null values are discarded
-
removeStringValues
Removes the supplied string as a value from this attribute.- Parameters:
value
- to remove, null values are discarded
-
removeStringValues
Removes all the strings in the supplied collection as values from this attribute.- Parameters:
values
- to remove, null values are discarded
-
removeBufferValues
Removes all the buffers in the supplied collection as values from this attribute.- Parameters:
values
- to remove, null values are discarded
-
removeBufferValues
Removes all the buffers in the supplied collection as values from this attribute.- Parameters:
values
- to remove, null values are discarded
-
size
public int size()Returns the number of values in this ldap attribute.- Returns:
- number of values in this ldap attribute
-
clear
public void clear()Removes all the values in this ldap attribute. -
equals
-
hashCode
public int hashCode() -
toString
-
sort
Returns a new attribute whose values are sorted. String values are sorted naturally. Binary values are sorted usingByteBuffer.compareTo(ByteBuffer)
.- Parameters:
la
- attribute to sort- Returns:
- sorted attribute
-
escapeValue
Deprecated.Escapes the supplied string value per RFC 4514 section 2.4.- Parameters:
value
- to escape- Returns:
- escaped value
-
builder
Creates a builder for this class.- Returns:
- new builder
-
DefaultAttributeValueEscaper