public interface EntryAttribute extends Iterable<Value<?>>, Cloneable, Externalizable
Modifier and Type | Method and Description |
---|---|
int |
add(byte[]... vals)
Adds some values to this attribute.
|
int |
add(String... vals)
Adds some values to this attribute.
|
int |
add(Value<?>... val)
Adds some values to this attribute.
|
void |
clear()
Remove all the values from this attribute.
|
EntryAttribute |
clone() |
boolean |
contains(byte[]... vals)
Indicates whether the specified values are some of the attribute's values.
|
boolean |
contains(String... vals)
Indicates whether the specified values are some of the attribute's values.
|
boolean |
contains(Value<?>... vals)
Indicates whether the specified values are some of the attribute's values.
|
Value<?> |
get()
Get the first value of this attribute.
|
Value<?> |
get(int i)
Get the nth value of this attribute.
|
Iterator<Value<?>> |
getAll()
Returns an iterator over all the attribute's values.
|
AttributeType |
getAttributeType()
Get the attribute type associated with this ServerAttribute.
|
byte[] |
getBytes()
Get the byte[] value, if and only if the value is known to be Binary,
otherwise a InvalidAttributeValueException will be thrown
|
String |
getId()
Get's the attribute identifier for this entry.
|
String |
getString()
Get the String value, if and only if the value is known to be a String,
otherwise a InvalidAttributeValueException will be thrown
|
String |
getUpId()
Get's the user provided identifier for this entry.
|
boolean |
instanceOf(String attributeId)
Check if the current attribute type is of the expected attributeType
|
boolean |
isHR()
Tells if the attribute is Human Readable.
|
boolean |
isValid()
Checks to see if this attribute is valid along with the values it contains.
|
boolean |
isValid(SyntaxChecker checker)
Checks to see if this attribute is valid along with the values it contains.
|
int |
put(byte[]... vals)
Puts some values to this attribute.
|
int |
put(List<Value<?>> vals)
Puts a list of values into this attribute.
|
int |
put(String... vals)
Puts some values to this attribute.
|
int |
put(Value<?>... vals)
Puts some values to this attribute.
|
boolean |
remove(byte[]... val)
Removes all the values that are equal to the given values.
|
boolean |
remove(String... vals)
Removes all the values that are equal to the given values.
|
boolean |
remove(Value<?>... vals)
Removes all the values that are equal to the given values.
|
void |
setAttributeType(AttributeType attributeType)
Set the attribute type associated with this ServerAttribute.
|
void |
setHR(boolean isHR)
Set the attribute to Human Readable or to Binary.
|
void |
setId(String id)
Set the normalized ID.
|
void |
setUpId(String upId)
Set the user provided ID.
|
void |
setUpId(String upId,
AttributeType attributeType)
Set the user provided ID.
|
int |
size()
Retrieves the number of values in this attribute.
|
EntryAttribute |
toClientAttribute()
Convert the ServerAttribute to a ClientAttribute
|
readExternal, writeExternal
int add(String... vals)
The new values are added at the end of list of values.
This method returns the number of values that were added.
If the value's type is different from the attribute's type, a conversion is done. For instance, if we try to set some String into a Binary attribute, we just store the UTF-8 byte array encoding for this String.
If we try to store some byte[] in a HR attribute, we try to convert those byte[] assuming they represent an UTF-8 encoded String. Of course, if it's not the case, the stored value will be incorrect.
It's the responsibility of the caller to check if the stored values are consistent with the attribute's type.
The caller can set the HR flag in order to enforce a type for the current attribute, otherwise this type will be set while adding the first value, using the value's type to set the flag.
vals
- some new values to be added which may be nullint add(byte[]... vals)
The new values are added at the end of list of values.
This method returns the number of values that were added.
If the value's type is different from the attribute's type, a conversion is done. For instance, if we try to set some String into a Binary attribute, we just store the UTF-8 byte array encoding for this String. If we try to store some byte[] in a HR attribute, we try to convert those byte[] assuming they represent an UTF-8 encoded String. Of course, if it's not the case, the stored value will be incorrect.vals
- some new values to be added which may be nullint add(Value<?>... val)
The new values are added at the end of list of values.
This method returns the number of values that were added.
If the value's type is different from the attribute's type, a conversion is done. For instance, if we try to set some StringValue into a Binary attribute, we just store the UTF-8 byte array encoding for this StringValue.
If we try to store some BinaryValue in a HR attribute, we try to convert those BinaryValue assuming they represent an UTF-8 encoded String. Of course, if it's not the case, the stored value will be incorrect.
It's the responsibility of the caller to check if the stored values are consistent with the attribute's type.
The caller can set the HR flag in order to enforce a type for the current attribute, otherwise this type will be set while adding the first value, using the value's type to set the flag.
Note : If the entry contains no value, and the unique added value is a null length value, then this value will be considered as a binary value.
vals
- some new values to be added which may be nullvoid clear()
EntryAttribute clone()
boolean contains(String... vals)
Indicates whether the specified values are some of the attribute's values.
If the Attribute is not HR, the values will be converted to byte[]
vals
- the valuesboolean contains(byte[]... vals)
Indicates whether the specified values are some of the attribute's values.
If the Attribute is HR, the values will be converted to String
vals
- the valuesboolean contains(Value<?>... vals)
Indicates whether the specified values are some of the attribute's values.
If the Attribute is HR, the binary values will be converted to String before being checked.
vals
- the valuesAttributeType getAttributeType()
void setAttributeType(AttributeType attributeType)
Set the attribute type associated with this ServerAttribute.
The current attributeType will be replaced. It is the responsibility of the caller to insure that the existing values are compatible with the new AttributeType
attributeType
- the attributeType associated with this entry attributeboolean instanceOf(String attributeId) throws LdapInvalidAttributeValueException
Check if the current attribute type is of the expected attributeType
This method won't tell if the current attribute is a descendant of the attributeType. For instance, the "CN" serverAttribute will return false if we ask if it's an instance of "Name".
attributeId
- The AttributeType ID to checkLdapInvalidAttributeValueException
- If there is no AttributeTypeValue<?> get()
Get the first value of this attribute. If there is none, null is returned.
Note : even if we are storing values into a Set, one can assume the values are ordered following the insertion order.
This method is meant to be used if the attribute hold only one value.
Iterator<Value<?>> getAll()
The effect on the returned enumeration of adding or removing values of the attribute is not specified.
This method will throw any NamingException
that occurs.
Value<?> get(int i)
Get the nth value of this attribute. If there is none, null is returned.
Note : even if we are storing values into a Set, one can assume the values are ordered following the insertion order.
i
- the index of the value to getbyte[] getBytes() throws LdapInvalidAttributeValueException
Get the byte[] value, if and only if the value is known to be Binary, otherwise a InvalidAttributeValueException will be thrown
Note that this method returns the first value only.
LdapInvalidAttributeValueException
- If the value is a StringString getId()
String getUpId()
boolean isHR()
Tells if the attribute is Human Readable.
This flag is set by the caller, or implicitly when adding String values into an attribute which is not yet declared as Binary.
String getString() throws LdapInvalidAttributeValueException
Get the String value, if and only if the value is known to be a String, otherwise a InvalidAttributeValueException will be thrown
Note that this method returns the first value only.
LdapInvalidAttributeValueException
- If the value is a byte[]int put(String... vals)
The new values will replace the previous values.
This method returns the number of values that were put.
val
- some values to be put which may be nullint put(byte[]... vals)
The new values will replace the previous values.
This method returns the number of values that were put.
val
- some values to be put which may be nullint put(Value<?>... vals)
The new values are replace the previous values.
This method returns the number of values that were put.
val
- some values to be put which may be nullint put(List<Value<?>> vals)
Puts a list of values into this attribute.
The new values will replace the previous values.
This method returns the number of values that were put.
vals
- the values to be putboolean remove(String... vals)
Removes all the values that are equal to the given values.
Returns true if all the values are removed.
If the attribute type is not HR, then the values will be first converted to byte[]
vals
- the values to be removedboolean remove(byte[]... val)
Removes all the values that are equal to the given values.
Returns true if all the values are removed.
If the attribute type is HR, then the values will be first converted to String
vals
- the values to be removedboolean remove(Value<?>... vals)
Removes all the values that are equal to the given values.
Returns true if all the values are removed.
If the attribute type is HR and some value which are not String, we will convert the values first (same thing for a non-HR attribute).
vals
- the values to be removedvoid setHR(boolean isHR)
Set the attribute to Human Readable or to Binary.
isHR
- true
for a Human Readable attribute,
false
for a Binary attribute.void setId(String id)
id
- The attribute IDIllegalArgumentException
- If the ID is empty or null or
resolve to an empty value after being trimmedvoid setUpId(String upId)
upId
- The attribute IDIllegalArgumentException
- If the ID is empty or null or
resolve to an empty value after being trimmedvoid setUpId(String upId, AttributeType attributeType)
Set the user provided ID. If we have none, the upId is assigned the attributetype's name. If it does not have any name, we will use the OID.
If we have an upId and an AttributeType, they must be compatible. : - if the upId is an OID, it must be the AttributeType's OID - otherwise, its normalized form must be equals to ones of the attributeType's names.
In any case, the ATtributeType will be changed. The caller is responsible for the present values to be compatoble with the new AttributeType.
upId
- The attribute IDattributeType
- The associated attributeTypeint size()
boolean isValid() throws LdapException
Checks to see if this attribute is valid along with the values it contains.
An attribute is valid if :
LdapException
- if there is a failure to check syntaxes of valuesboolean isValid(SyntaxChecker checker) throws LdapException
checker
- The syntax checkerLdapException
- if there is a failure to check syntaxes of valuesEntryAttribute toClientAttribute()
Copyright © 2003-2012 Apache Software Foundation. All Rights Reserved.