com.rli.slapd.server

Class LDAPAttribute

java.lang.Object

com.rli.slapd.server.LDAPAttribute

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LDAPAttribute
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Represents the name and values of an attribute in an entry.

See Also:

LDAPAttributeSet, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isDuplicatedAllowed

Constructor Summary

Constructors

Constructor and Description
LDAPAttribute(BERElement element) Constructs an attribute from a BER (Basic Encoding Rules) element.
LDAPAttribute(LDAPAttribute attr) Constructs an attribute from another existing attribute.
LDAPAttribute(java.lang.String attrName) Constructs an attribute with no values.
LDAPAttribute(java.lang.String attrName, boolean isDuplicatedAllowed)
LDAPAttribute(java.lang.String attrName, byte[] attrValue) Constructs an attribute with a byte-formatted value.
LDAPAttribute(java.lang.String attrName, byte[][] arrayAttrValue) Constructs an attribute with a byte-formatted value.
LDAPAttribute(java.lang.String attrName, byte[] attrValue, boolean isDuplicatedAllowed)
LDAPAttribute(java.lang.String attrName, java.util.Collection<byte[]> attrValue) constructor with byte[]
LDAPAttribute(java.lang.String attrName, java.util.List<java.lang.String> attrValues) constructor with String
LDAPAttribute(java.lang.String attrName, java.lang.Object[] attrValue)
LDAPAttribute(java.lang.String attrName, java.lang.Object[] attrValue, boolean isDuplicatedAllowed)
LDAPAttribute(java.lang.String attrName, java.lang.String attrValue) Constructs an attribute that has a single string value.
LDAPAttribute(java.lang.String attrName, java.lang.String[] attrValues) Constructs an attribute that has an array of string values.
LDAPAttribute(java.lang.String attrName, java.lang.String[] attrValues, boolean isDuplicatedAllowed)
LDAPAttribute(java.lang.String attrName, java.lang.String attrValue, boolean isDuplicatedAllowed)
LDAPAttribute(java.lang.String attrName, java.util.Vector<byte[]> attrValue, boolean isDuplicatedAllowed)

Method Summary

Modifier and Type	Method and Description
void	addValue(byte[] attrValue) Adds a byte[]-formatted value to the attribute.
void	addValue(java.lang.Object attrValue)
void	addValue(java.lang.String attrValue) Adds a string value to the attribute.
protected void	addValue(java.lang.String strValue, byte[] byteValue) Adds a value to the attribute.
protected void	addValue(java.lang.String strValue, byte[] byteValue, boolean avoidCheckDuplicated) Adds a value to the attribute.
void	addValues(java.lang.String[] arrayStrValue) add arrray of str to values, each value will be checked for duplicated is checking is required.
boolean	addValueStrAllowDecodeB64(java.lang.String attrValue) add string, if base64binary, decode it before adding.
void	clear()
java.lang.Object	clone()
boolean	contains(byte[] attrValue)
boolean	containsIgnoreCase(byte[] attrValue) return true if value is contained in attribute, check ignore case
boolean	containsIgnoreCase(java.lang.String attrValue) return true if value is contained in attribute, check ignore case
static void	decrypt(LDAPAttribute attr) Decrypt attibute Here is how the decryption works: 1) if the value does not start with "{}", no change; 2) if the value does start with "{}", then it is assumed that BASE64 encoded string follows.
void	deleteAllValues()
static void	encrypt(LDAPAttribute attr) Use the deafult/global CryptoManager to encrypt attibute Here is how encryption works: 1) if the value does start with "{}", no change -- assuming it has been encrypted already 2) After encryption, the encryped value should bear the following format: encrypedValue :: = {} Base64EencodedString :: = base64.encode() encryptedBytes :: = 3) change or not at all -- if any bad things should happen, the attribute remains unchanged (excpetion thrown though).
static void	encrypt(LDAPAttribute attr, boolean forceNoSalt)
static void	encrypt(LDAPAttribute attr, CryptoManager cm) Use the given CryptoManager to encrypt attibute Here is how encryption works: 1) if the value does start with "{}", no change -- assuming it has been encrypted already 2) After encryption, the encryped value should bear the following format: encrypedValue :: = {} Base64EencodedString :: = base64.encode() encryptedBytes :: = 3) change or not at all -- if any bad things should happen, the attribute remains unchanged (excpetion thrown though).
static void	encrypt(LDAPAttribute attr, CryptoManager cm, boolean forceNoSalt)
boolean	equals(java.lang.Object obj) - equals attr name (ignore case) - equals values, same order, respect case
static LDAPAttribute	findLDAPAttribute(LDAPAttribute[] arrayLDAPAttribute, java.lang.String attrName) find attribute by its name, return null if not found.
protected java.lang.String	findValueAsStored(java.lang.String attrValue) returns value as stored, not found returns null.
static byte[]	generateByteValue(java.lang.String valueString)
static java.lang.String	generateStringValue(byte[] valueByte)
java.util.Enumeration<java.lang.Object>	getAll() each object returned could be String or byte[] depending on what it was when orignally added to attribute
java.util.List<java.lang.Object>	getAllValues()
java.lang.String	getBaseName() Extracts the base name from the attribute name of the current LDAPAttribute object.
static java.lang.String	getBaseName(java.lang.String attrName) Extracts the base name from the specified attribute name.
BERElement	getBERElement() Retrieves the BER (Basic Encoding Rules) representation of an attribute.
byte[][]	getByteValueArray() Returns the values of the attribute in an array of byte[] format.
java.lang.Object[]	getByteValueInObjectArray()
java.util.Enumeration<byte[]>	getByteValues() Returns an enumerator for the values of the attribute in byte[] format.
byte[]	getFirsValueArrayByte() just return the first value of the result or null if nothing found.
java.lang.String	getFirsValueGUIDString() returns the first value of the result as GUID formatted String or null if nothing found.
java.lang.String	getFirsValueSIDString() returns the first value of the result as SID formatted String or null if nothing found.
java.lang.String	getFirsValueString() just return the first value of the result or null if nothing found.
java.lang.String	getLangSubtype() Extracts the language subtype from the attribute name of the LDAPAttribute object, if any.
java.util.List<byte[]>	getListValueArrayByte() return values as a list of byte[] (best perf to retrieve data, return stored list)
java.util.Collection<java.lang.String>	getListValueString() return values as a list of String
java.util.Collection<java.lang.String>	getListValueString(boolean lowerCase) return values as a list of String
java.lang.String	getName() Returns the name of the attribute.
java.util.Set<java.lang.String>	getOptions()
java.util.Collection<java.lang.String>	getSafeCopyListValueString() return values as a (safe) copied list of String - useful for modifying the values while enumerating them or to safely modify them without affecting the attribute itself
java.lang.String	getStringValue(int index)
java.lang.String[]	getStringValueArray() Returns the values of the attribute as an array of String objects.
java.lang.String[]	getStringValueArray(boolean tob64)
java.util.Enumeration<java.lang.String>	getStringValues() Returns an enumerator for the string values of an attribute.
java.lang.String[]	getSubtypes() Extracts the subtypes from the attribute name of the current LDAPAttribute object.
static java.lang.String[]	getSubtypes(java.lang.String attrName) Extracts the subtypes from the specified attribute name.
boolean	hasSubtype(java.lang.String subtype) Reports whether the attribute name contains the specified subtype.
boolean	hasSubtypes(java.lang.String[] subtypes) Reports if the attribute name contains all specified subtypes For example, if you check for the subtypes lang-en and phonetic and the attribute name is cn;lang-en;phonetic, this method returns true.
boolean	isDuplicatedAllowed()
boolean	isMultiValued() more than one value
static boolean	isPrintable(byte[] b) Returns true if all the bytes in the given array are valid for output as a String according to the LDIF specification.
boolean	isRangedAttribute()
boolean	isString(int index) return true if attribute found as index was inserted as a string
static boolean	isValidUTF8(byte[] input)
static boolean	isValueDuplicate(java.lang.Object[] values)
static boolean	isValueDuplicate(java.lang.Object[] values, boolean caseIgnoreMatch)
static boolean	isValueDuplicateIgnoreCase(java.lang.Object[] values)
static void	main(java.lang.String[] args)
void	mergeAttributeValue(LDAPAttribute attr) merge current value with value from another attr.
void	mergeAttributeValue(LDAPAttribute attr, boolean ignoreCase) merge current value with value from another attr.
boolean	removeValue(byte[] attrValue) Removes a string value from the attribute.
boolean	removeValue(java.lang.String attrValue) Removes a string value from the attribute.
boolean	removeValue(java.lang.String strValue, byte[] byteValue)
boolean	removeValueAllowDecodeB64(java.lang.String attrValue) remove string, if base64binary, decode it before removeing.
boolean	removeValueIgnoreCase(byte[] attrValue) Removes a value from the attribute by ignoring its case.
boolean	removeValueIgnoreCase(java.lang.String attrValue) Removes a string value from the attribute.
void	setDuplicatedAllowed(boolean isDuplicatedAllowed)
void	setName(java.lang.String attrName)
void	setOptions(java.util.Set<java.lang.String> options)
void	setString(boolean isString) consider all attribute as string type
void	setValue(java.lang.String attrValue) for attr with only one value
protected void	setValues(byte[][] arrayAttrValue) do not check duplicate
void	setValues(java.util.Collection<byte[]> colAttrValue) do not check duplicate
void	setValues(java.lang.Object[] arrayAttrValue) do not check duplicate
void	setValues(java.lang.String[] arrayAttrValue) do not check duplicate
void	setValues(java.util.Vector<byte[]> vertorOfByteArray) do not check duplicate all values are considered as binary for meta analysis
static int	setValuesRange(LDAPAttribute attr, int minrange, int maxrange)
static int	setValuesRangeAndName(LDAPAttribute attr, int minrange, int maxrange)
void	setValuesStr(java.util.Collection<java.lang.String> attrValues)
void	setValuesStr(java.util.List<java.lang.String> attrValues)
int	size() Returns the number of values of the attribute.
java.lang.String	toOrderedString()
java.lang.String	toString() Retrieves the string representation of an attribute in an LDAP entry.
java.lang.String	toString(java.lang.String entryDn)

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

isDuplicatedAllowed

protected boolean isDuplicatedAllowed

Constructor Detail

LDAPAttribute

public LDAPAttribute(LDAPAttribute attr)

Constructs an attribute from another existing attribute. Effectively, this makes a copy of the existing attribute. equilvalent to attr.clone()

Parameters:

attr - the attribute to copy

LDAPAttribute

public LDAPAttribute(java.lang.String attrName)

Constructs an attribute with no values.

Parameters:

attrName - name of the attribute

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     boolean isDuplicatedAllowed)

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     byte[] attrValue)

Constructs an attribute with a byte-formatted value.

Parameters:

attrName - name of the attribute

attrValue - value of the attribute in byte format

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     byte[][] arrayAttrValue)

Constructs an attribute with a byte-formatted value.

Parameters:

attrName - name of the attribute

arrayAttrValue - values of the attribute in byte format

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     byte[] attrValue,
                     boolean isDuplicatedAllowed)

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     java.lang.String attrValue)

Constructs an attribute that has a single string value.

Parameters:

attrName - name of the attribute

attrValue - value of the attribute in String format

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     java.lang.String attrValue,
                     boolean isDuplicatedAllowed)

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     java.lang.Object[] attrValue)

Parameters:

attrName -

attrValue - each object could be String or byte[]

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     java.lang.Object[] attrValue,
                     boolean isDuplicatedAllowed)

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     java.util.List<java.lang.String> attrValues)

constructor with String

Parameters:

attrName -

attrValues -

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     java.util.Collection<byte[]> attrValue)

constructor with byte[]

Parameters:

attrName -

attrValue -

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     java.util.Vector<byte[]> attrValue,
                     boolean isDuplicatedAllowed)

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     java.lang.String[] attrValues)

Constructs an attribute that has an array of string values.

Parameters:

attrName - name of the attribute

attrValues - the list of string values for this attribute

LDAPAttribute

public LDAPAttribute(java.lang.String attrName,
                     java.lang.String[] attrValues,
                     boolean isDuplicatedAllowed)

LDAPAttribute

public LDAPAttribute(BERElement element)
              throws java.io.IOException

Constructs an attribute from a BER (Basic Encoding Rules) element. (The protocol elements of LDAP are encoded for exchange using the Basic Encoding Rules.)

Parameters:

element - element that you want translated into an attribute

Throws:

java.io.IOException - The attribute could not be created from the specified element.

Method Detail

size

public int size()

Returns the number of values of the attribute.

Returns:

number of values for this attribute.

getStringValues

public java.util.Enumeration<java.lang.String> getStringValues()

Returns an enumerator for the string values of an attribute.

Returns:

enumerator for the string values.

getStringValueArray

public java.lang.String[] getStringValueArray()

Returns the values of the attribute as an array of String objects.

Returns:

array of attribute values. Each element in the array is a String object.

getStringValueArray

public java.lang.String[] getStringValueArray(boolean tob64)

getByteValues

public java.util.Enumeration<byte[]> getByteValues()

Returns an enumerator for the values of the attribute in byte[] format.

Returns:

a set of attribute values. Each element in the enumeration is of type byte[].

getByteValueInObjectArray

public java.lang.Object[] getByteValueInObjectArray()

getListValueArrayByte

public java.util.List<byte[]> getListValueArrayByte()

return values as a list of byte[] (best perf to retrieve data, return stored list)

Returns:

getListValueString

public java.util.Collection<java.lang.String> getListValueString()

return values as a list of String

Returns:

getSafeCopyListValueString

public java.util.Collection<java.lang.String> getSafeCopyListValueString()

return values as a (safe) copied list of String - useful for modifying the values while enumerating them or to safely modify them without affecting the attribute itself

Returns:

getListValueString

public java.util.Collection<java.lang.String> getListValueString(boolean lowerCase)

return values as a list of String

Parameters:

lowerCase - put all value Str to lower case. WARNING: value are still stored as is before lowering case.

Returns:

getByteValueArray

public byte[][] getByteValueArray()

Returns the values of the attribute in an array of byte[] format.

Returns:

array of attribute values. Each element in the array will be of type byte[].

getName

public java.lang.String getName()

Returns the name of the attribute.

Returns:

name of the attribute.

getSubtypes

public static java.lang.String[] getSubtypes(java.lang.String attrName)

Extracts the subtypes from the specified attribute name. For example, if the attribute name is cn;lang-ja;phonetic, this method returns an array containing lang-ja and phonetic.

Parameters:

attrName - name of the attribute from which to extract the subtypes

Returns:

array of subtypes, or null (if the name has no subtypes).

See Also:

LDAPAttribute.getBaseName()

getSubtypes

public java.lang.String[] getSubtypes()

Extracts the subtypes from the attribute name of the current LDAPAttribute object. For example, if the attribute name is cn;lang-ja;phonetic, this method returns an array containing lang-ja and phonetic.

Returns:

array of subtypes, or null (if the name has no subtypes).

getLangSubtype

public java.lang.String getLangSubtype()

Extracts the language subtype from the attribute name of the LDAPAttribute object, if any. For example, if the attribute name is cn;lang-ja;phonetic, this method returns the String lang-ja.

Returns:

the language subtype, or null (if the name has no language subtype).

getBaseName

public static java.lang.String getBaseName(java.lang.String attrName)

Extracts the base name from the specified attribute name. For example, if the attribute name is cn;lang-ja;phonetic, this method returns cn.

Parameters:

attrName - name of the attribute from which to extract the base name

Returns:

base name (the attribute name without any subtypes).

See Also:

LDAPAttribute.getSubtypes()

getBaseName

public java.lang.String getBaseName()

Extracts the base name from the attribute name of the current LDAPAttribute object. For example, if the attribute name is cn;lang-ja;phonetic, this method returns cn.

Returns:

base name (the attribute name without any subtypes).

See Also:

LDAPAttribute.getSubtypes()

hasSubtype

public boolean hasSubtype(java.lang.String subtype)

Reports whether the attribute name contains the specified subtype. For example, if you check for the subtype lang-en and the attribute name is cn;lang-en, this method returns true.

Parameters:

subtype - the single subtype for which you want to check

Returns:

true if the attribute name contains the specified subtype.

See Also:

LDAPAttribute.getSubtypes()

hasSubtypes

public boolean hasSubtypes(java.lang.String[] subtypes)

Reports if the attribute name contains all specified subtypes For example, if you check for the subtypes lang-en and phonetic and the attribute name is cn;lang-en;phonetic, this method returns true. If the attribute name is cn;phonetic or cn;lang-en, this method returns false.

Parameters:

subtypes - an array of subtypes to check

Returns:

true if the attribute name contains all subtypes

See Also:

LDAPAttribute.getSubtypes()

addValue

public void addValue(java.lang.String attrValue)

Adds a string value to the attribute.

Parameters:

attrValue - the string value to add to the attribute

addValue

public void addValue(java.lang.Object attrValue)

addValues

public void addValues(java.lang.String[] arrayStrValue)

add arrray of str to values, each value will be checked for duplicated is checking is required.

Parameters:

arrayStrValue -

addValue

protected void addValue(java.lang.String strValue,
                        byte[] byteValue)

Adds a value to the attribute. at least one attr should be provided, having both type of attr provided is better avoiding object creation.

Parameters:

strValue -

byteValue -

addValue

protected void addValue(java.lang.String strValue,
                        byte[] byteValue,
                        boolean avoidCheckDuplicated)

Adds a value to the attribute. at least one attr should be provided, having both type of attr provided is better avoiding object creation.

Parameters:

strValue -

byteValue -

addValue

public void addValue(byte[] attrValue)

Adds a byte[]-formatted value to the attribute.

Parameters:

attrValue - the byte[]-formatted value to add to the attribute

contains

public boolean contains(byte[] attrValue)

containsIgnoreCase

public boolean containsIgnoreCase(byte[] attrValue)

return true if value is contained in attribute, check ignore case

Parameters:

attrValue -

Returns:

containsIgnoreCase

public boolean containsIgnoreCase(java.lang.String attrValue)

return true if value is contained in attribute, check ignore case

Parameters:

attrValue -

Returns:

findValueAsStored

protected java.lang.String findValueAsStored(java.lang.String attrValue)

returns value as stored, not found returns null. Ignore case.

Parameters:

attrValue -

Returns:

setName

public void setName(java.lang.String attrName)

setValue

public void setValue(java.lang.String attrValue)

for attr with only one value

Parameters:

attrValue -

setValues

protected void setValues(byte[][] arrayAttrValue)

do not check duplicate

Parameters:

arrayAttrValue -

setValues

public void setValues(java.lang.Object[] arrayAttrValue)

do not check duplicate

Parameters:

arrayAttrValue - each object could be String or byte[]

setValues

public void setValues(java.lang.String[] arrayAttrValue)

do not check duplicate

Parameters:

arrayAttrValue -

setValuesStr

public void setValuesStr(java.util.Collection<java.lang.String> attrValues)

setValuesStr

public void setValuesStr(java.util.List<java.lang.String> attrValues)

setValues

public void setValues(java.util.Collection<byte[]> colAttrValue)

do not check duplicate

Parameters:

arrayAttrValue -

setValues

public void setValues(java.util.Vector<byte[]> vertorOfByteArray)

do not check duplicate all values are considered as binary for meta analysis

Parameters:

vertorOfByteArray -

removeValue

public boolean removeValue(java.lang.String attrValue)

Removes a string value from the attribute.

Parameters:

attrValue - the string value to remove

removeValueIgnoreCase

public boolean removeValueIgnoreCase(java.lang.String attrValue)

Removes a string value from the attribute.

Parameters:

attrValue - the string value to remove

removeValue

public boolean removeValue(byte[] attrValue)

Removes a string value from the attribute.

Parameters:

attrValue - the string value to remove

removeValueIgnoreCase

public boolean removeValueIgnoreCase(byte[] attrValue)

Removes a value from the attribute by ignoring its case.

Parameters:

attrValue - the value to remove

removeValueAllowDecodeB64

public boolean removeValueAllowDecodeB64(java.lang.String attrValue)

remove string, if base64binary, decode it before removeing.

Parameters:

attrValue -

Returns:

true if the value was found and removed

removeValue

public boolean removeValue(java.lang.String strValue,
                           byte[] byteValue)

getBERElement

public BERElement getBERElement()

Retrieves the BER (Basic Encoding Rules) representation of an attribute. (The protocol elements of LDAP are encoded for exchange using the Basic Encoding Rules.)

Returns:

the BER representation of the attribute.

toOrderedString

public java.lang.String toOrderedString()

isPrintable

public static boolean isPrintable(byte[] b)

Returns true if all the bytes in the given array are valid for output as a String according to the LDIF specification. If not, the array should output base64-encoded.

Returns:

true if all the bytes in the given array are valid for output as a String according to the LDIF specification; otherwise, false.

isValidUTF8

public static boolean isValidUTF8(byte[] input)

toString

public java.lang.String toString()

Retrieves the string representation of an attribute in an LDAP entry. For example:

 LDAPAttribute {type='cn', values='Barbara Jensen,Babs Jensen'}
 

Overrides:

toString in class java.lang.Object

Returns:

string representation of the attribute.

toString

public java.lang.String toString(java.lang.String entryDn)

isDuplicatedAllowed

public boolean isDuplicatedAllowed()

main

public static void main(java.lang.String[] args)

getFirsValueString

public java.lang.String getFirsValueString()

just return the first value of the result or null if nothing found. (avoid looping list when only the first value) use getFirsValueString() instead of getStringValueArray()[0].

Returns:

getFirsValueArrayByte

public byte[] getFirsValueArrayByte()

just return the first value of the result or null if nothing found. (avoid looping list when only the first value) use getFirsValueString() instead of getStringValueArray()[0].

Returns:

getFirsValueGUIDString

public java.lang.String getFirsValueGUIDString()

returns the first value of the result as GUID formatted String or null if nothing found.

Returns:

getFirsValueSIDString

public java.lang.String getFirsValueSIDString()

returns the first value of the result as SID formatted String or null if nothing found.

Returns:

findLDAPAttribute

public static LDAPAttribute findLDAPAttribute(LDAPAttribute[] arrayLDAPAttribute,
                                              java.lang.String attrName)

find attribute by its name, return null if not found.

Parameters:

arrayLDAPAttribute -

attrName -

Returns:

deleteAllValues

public void deleteAllValues()

addValueStrAllowDecodeB64

public boolean addValueStrAllowDecodeB64(java.lang.String attrValue)

add string, if base64binary, decode it before adding.

Parameters:

attrValue -

Returns:

true if value was binary

equals

public boolean equals(java.lang.Object obj)

- equals attr name (ignore case) - equals values, same order, respect case

Overrides:

equals in class java.lang.Object

isMultiValued

public boolean isMultiValued()

more than one value

Returns:

mergeAttributeValue

public void mergeAttributeValue(LDAPAttribute attr)

merge current value with value from another attr. ignore duplicate values, RESPECT case.

Parameters:

attr -

mergeAttributeValue

public void mergeAttributeValue(LDAPAttribute attr,
                                boolean ignoreCase)

merge current value with value from another attr. ignore duplicate values

Parameters:

attr -

ignoreCase - ignoring case.

generateStringValue

public static java.lang.String generateStringValue(byte[] valueByte)

generateByteValue

public static byte[] generateByteValue(java.lang.String valueString)

setOptions

public void setOptions(java.util.Set<java.lang.String> options)

getOptions

public java.util.Set<java.lang.String> getOptions()

setDuplicatedAllowed

public void setDuplicatedAllowed(boolean isDuplicatedAllowed)

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

isString

public boolean isString(int index)

return true if attribute found as index was inserted as a string

Parameters:

index -

Returns:

getStringValue

public java.lang.String getStringValue(int index)

clear

public void clear()

getAll

public java.util.Enumeration<java.lang.Object> getAll()

each object returned could be String or byte[] depending on what it was when orignally added to attribute

Returns:

getAllValues

public java.util.List<java.lang.Object> getAllValues()

setString

public void setString(boolean isString)

consider all attribute as string type

Parameters:

isString -

isValueDuplicate

public static boolean isValueDuplicate(java.lang.Object[] values)

isValueDuplicateIgnoreCase

public static boolean isValueDuplicateIgnoreCase(java.lang.Object[] values)

isValueDuplicate

public static boolean isValueDuplicate(java.lang.Object[] values,
                                       boolean caseIgnoreMatch)

encrypt

public static void encrypt(LDAPAttribute attr)
                    throws LDAPException

Use the deafult/global CryptoManager to encrypt attibute Here is how encryption works: 1) if the value does start with "{}", no change -- assuming it has been encrypted already 2) After encryption, the encryped value should bear the following format: encrypedValue :: = {} Base64EencodedString :: = base64.encode() encryptedBytes :: = 3) change or not at all -- if any bad things should happen, the attribute remains unchanged (excpetion thrown though).

Parameters:

attr - the LDAPAttribute

forceNoSalt - force the cipher text without salting

Throws:

LDAPException

encrypt

public static void encrypt(LDAPAttribute attr,
                           boolean forceNoSalt)
                    throws LDAPException

Throws:

LDAPException

encrypt

public static void encrypt(LDAPAttribute attr,
                           CryptoManager cm)
                    throws LDAPException

Use the given CryptoManager to encrypt attibute Here is how encryption works: 1) if the value does start with "{}", no change -- assuming it has been encrypted already 2) After encryption, the encryped value should bear the following format: encrypedValue :: = {} Base64EencodedString :: = base64.encode() encryptedBytes :: = 3) change or not at all -- if any bad things should happen, the attribute remains unchanged (excpetion thrown though).

Parameters:

attr - the LDAPAttribute

forceNoSalt - force the cipher text without salting

Throws:

LDAPException

encrypt

public static void encrypt(LDAPAttribute attr,
                           CryptoManager cm,
                           boolean forceNoSalt)
                    throws LDAPException

Throws:

LDAPException

decrypt

public static void decrypt(LDAPAttribute attr)
                    throws LDAPException

Decrypt attibute Here is how the decryption works: 1) if the value does not start with "{}", no change; 2) if the value does start with "{}", then it is assumed that BASE64 encoded string follows. encryptedBytes :: = 3) find the associated symmetric key based based on the given 4) use the key decypt the given 4) change or not at all -- if any bad things should happen, the attribute remains unchanged (excpetion thrown though).

Parameters:

attr -

Throws:

LDAPException

setValuesRange

public static int setValuesRange(LDAPAttribute attr,
                                 int minrange,
                                 int maxrange)

setValuesRangeAndName

public static int setValuesRangeAndName(LDAPAttribute attr,
                                        int minrange,
                                        int maxrange)

isRangedAttribute

public boolean isRangedAttribute()