Package org.ldaptive.ad

Class UnicodePwdAttribute

java.lang.Object

org.ldaptive.AbstractFreezable

org.ldaptive.LdapAttribute

org.ldaptive.ad.UnicodePwdAttribute

All Implemented Interfaces:

Freezable

public class UnicodePwdAttribute
extends LdapAttribute

Helper class for the active directory unicodePwd attribute. Configures a binary attribute of that name and allows setting of the attribute value using a string. See UnicodePwdValueTranscoder.

Nested Class Summary

Nested classes/interfaces inherited from class org.ldaptive.LdapAttribute

LdapAttribute.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ATTR_NAME	name of this attribute.
private static final UnicodePwdValueTranscoder	TRANSCODER	transcoder used when adding string values.

Constructor Summary

Constructors

Constructor	Description
UnicodePwdAttribute()	Default constructor.
UnicodePwdAttribute(String... values)	Creates a new unicode pwd attribute.

Method Summary

Modifier and Type	Method	Description
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.
String	getStringValue()	Returns a single string value of this attribute.
Collection<String>	getStringValues()	Returns the values of this attribute as strings.

Methods inherited from class org.ldaptive.LdapAttribute

addBinaryValues, addBinaryValues, addValues, addValues, builder, clear, configureBinary, copy, equals, getBinaryValue, getBinaryValues, getName, getName, getOptions, getValue, getValues, hashCode, hasValue, hasValue, hasValue, isBinary, merge, removeBinaryValues, removeBinaryValues, removeStringValues, removeStringValues, removeValues, removeValues, setBinary, setName, size, sort, toString

Methods inherited from class org.ldaptive.AbstractFreezable

assertMutable, freeze, freeze, freeze, isFrozen

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ATTR_NAME

private static final String ATTR_NAME

name of this attribute.

See Also:

• Constant Field Values

TRANSCODER

private static final UnicodePwdValueTranscoder TRANSCODER

transcoder used when adding string values.

Constructor Details

UnicodePwdAttribute

public UnicodePwdAttribute()

Default constructor.

UnicodePwdAttribute

public UnicodePwdAttribute(String... values)

Creates a new unicode pwd attribute.

Parameters:

values - of this attribute

Method Details

getStringValue

public String getStringValue()

Description copied from class: LdapAttribute

Returns a single string value of this attribute.

Overrides:

getStringValue in class LdapAttribute

Returns:

single string attribute value or null if this attribute is empty

getStringValues

public Collection<String> getStringValues()

Description copied from class: LdapAttribute

Returns the values of this attribute as strings. Binary data is base64 encoded. The return collection cannot be modified.

Overrides:

getStringValues in class LdapAttribute

Returns:

collection of string attribute values

addStringValues

public void addStringValues(String... value)

Description copied from class: LdapAttribute

Adds the supplied string as a value for this attribute.

Overrides:

addStringValues in class LdapAttribute

Parameters:

value - to add, null values are discarded

addStringValues

public void addStringValues(Collection<String> values)

Description copied from class: LdapAttribute

Adds all the strings in the supplied collection as values for this attribute.

Overrides:

addStringValues in class LdapAttribute

Parameters:

values - to add, null values are discarded