public interface Entry extends java.lang.Cloneable, java.lang.Iterable<Attribute>, java.io.Externalizable
This interface represent a LDAP entry. An LDAP entry contains :
The available methods on this object are described in this interface.
This interface is used by the serverEntry and clientEntry interfaces.
| Modifier and Type | Method and Description |
|---|---|
Entry |
add(Attribute... attributes)
Add some Attributes to the current Entry.
|
Entry |
add(AttributeType attributeType,
byte[]... values)
Add an attribute (represented by its AttributeType and some binary values) into an
entry.
|
Entry |
add(AttributeType attributeType,
java.lang.String... values)
Add an attribute (represented by its AttributeType and some String values) into an
entry.
|
Entry |
add(AttributeType attributeType,
Value<?>... values)
Add an attribute (represented by its AttributeType and some values) into an
entry.
|
Entry |
add(java.lang.String upId,
AttributeType attributeType,
byte[]... values)
Add an attribute (represented by its AttributeType and some binary values) into an
entry.
|
Entry |
add(java.lang.String upId,
AttributeType attributeType,
java.lang.String... values)
Add an attribute (represented by its AttributeType and some String values) into an
entry.
|
Entry |
add(java.lang.String upId,
AttributeType attributeType,
Value<?>... values)
Add an attribute (represented by its AttributeType and some values) into an
entry.
|
Entry |
add(java.lang.String upId,
byte[]... values)
Add some binary values to the current Entry.
|
Entry |
add(java.lang.String upId,
java.lang.String... values)
Add some String values to the current Entry.
|
Entry |
add(java.lang.String upId,
Value<?>... values)
Add some Values to the current Entry.
|
void |
clear()
Remove all the attributes for this entry.
|
Entry |
clone()
Clone the current entry
|
boolean |
contains(Attribute... attributes)
Checks if an entry contains a list of attributes.
|
boolean |
contains(AttributeType attributeType,
byte[]... values)
Checks if an entry contains an attribute with some given binary values.
|
boolean |
contains(AttributeType attributeType,
java.lang.String... values)
Checks if an entry contains an attribute with some given String values.
|
boolean |
contains(AttributeType attributeType,
Value<?>... values)
Checks if an entry contains an attribute with some given binary values.
|
boolean |
contains(java.lang.String upId,
byte[]... values)
Checks if an entry contains an attribute with some binary values.
|
boolean |
contains(java.lang.String upId,
java.lang.String... values)
Checks if an entry contains an attribute with some String values.
|
boolean |
contains(java.lang.String upId,
Value<?>... values)
Checks if an entry contains an attribute with some values.
|
boolean |
containsAttribute(AttributeType attributeType)
Checks if an entry contains a specific AttributeType.
|
boolean |
containsAttribute(java.lang.String... attributes)
Checks if an entry contains some specific attributes.
|
Attribute |
get(AttributeType attributeType)
Returns the attribute associated with an AttributeType
|
Attribute |
get(java.lang.String alias)
Returns the attribute with the specified alias.
|
java.util.Collection<Attribute> |
getAttributes()
Gets all the attributes
|
Dn |
getDn()
Get this entry's Dn.
|
boolean |
hasObjectClass(Attribute... objectClasses)
Tells if an entry has some specific ObjectClasses Attributes
|
boolean |
hasObjectClass(java.lang.String... objectClasses)
Tells if an entry as some specific ObjectClasses values
|
boolean |
isSchemaAware()
Tells if the Entry is schema aware
|
java.util.Iterator<Attribute> |
iterator()
Returns an iterator on the attributes for this entry.
|
java.util.List<Attribute> |
put(Attribute... attributes)
Places attributes in the attribute collection.
|
Attribute |
put(AttributeType attributeType,
byte[]... values)
Places a new attribute with the supplied AttributeType and binary values
into the attribute collection.
|
Attribute |
put(AttributeType attributeType,
java.lang.String... values)
Places a new attribute with the supplied AttributeType and String values
into the attribute collection.
|
Attribute |
put(AttributeType attributeType,
Value<?>... values)
Places a new attribute with the supplied AttributeType and some values
into the attribute collection.
|
Attribute |
put(java.lang.String upId,
AttributeType attributeType,
byte[]... values)
Places a new attribute with the supplied AttributeType and some binary values
into the attribute collection.
|
Attribute |
put(java.lang.String upId,
AttributeType attributeType,
java.lang.String... values)
Places a new attribute with the supplied AttributeType and some String values
into the attribute collection.
|
Attribute |
put(java.lang.String upId,
AttributeType attributeType,
Value<?>... values)
Places a new attribute with the supplied AttributeType and some values
into the attribute collection.
|
Attribute |
put(java.lang.String upId,
byte[]... values)
Put an attribute (represented by its ID and some binary values) into an entry.
|
Attribute |
put(java.lang.String upId,
java.lang.String... values)
Put an attribute (represented by its ID and some String values) into an entry.
|
Attribute |
put(java.lang.String upId,
Value<?>... values)
Put an attribute (represented by its ID and some values) into an entry.
|
java.util.List<Attribute> |
remove(Attribute... attributes)
Removes the specified attributes.
|
boolean |
remove(AttributeType attributeType,
byte[]... values)
Removes the specified binary values from an attribute.
|
boolean |
remove(AttributeType attributeType,
java.lang.String... values)
Removes the specified String values from an attribute.
|
boolean |
remove(AttributeType attributeType,
Value<?>... values)
Removes the specified values from an attribute.
|
boolean |
remove(java.lang.String upId,
byte[]... values)
Removes the specified binary values from an attribute.
|
boolean |
remove(java.lang.String upId,
java.lang.String... values)
Removes the specified String values from an attribute.
|
boolean |
remove(java.lang.String upId,
Value<?>... values)
Removes the specified values from an attribute.
|
void |
removeAttributes(AttributeType... attributes)
Removes the attribute with the specified AttributeTypes.
|
void |
removeAttributes(java.lang.String... attributes)
Removes the attribute with the specified alias.
|
void |
setDn(Dn dn)
Set this entry's Dn.
|
void |
setDn(java.lang.String dn)
Set this entry's Dn.
|
Entry |
shallowClone()
Shallow Clone the current entry.
|
int |
size()
Returns the number of attributes.
|
java.lang.String |
toString(java.lang.String tabs)
A pretty-pinter for Entries
|
void clear()
Entry clone()
Entry shallowClone()
Dn getDn()
boolean hasObjectClass(java.lang.String... objectClasses)
objectClasses - The ObjectClasses we want to checktrue if all the ObjectClasses value are present
in the ObjectClass attributeboolean hasObjectClass(Attribute... objectClasses)
objectClasses - The ObjectClasses we want to checktrue if the ObjectClasses Attribute are present
in the ObjectClass attributeAttribute get(java.lang.String alias)
Returns the attribute with the specified alias. The return value
is null if no match is found.
An Attribute with an id different from the supplied alias may be returned: for example a call with 'cn' may in some implementations return an Attribute whose getId() field returns 'commonName'.
alias - an aliased name of the attribute identifierAttribute get(AttributeType attributeType)
attributeType - the AttributeType we are looking forjava.util.Collection<Attribute> getAttributes()
void setDn(Dn dn)
dn - The Dn associated with this entryvoid setDn(java.lang.String dn)
throws LdapInvalidDnException
dn - The String Dn associated with this entryLdapInvalidDnException - if the provided Dn is invalidjava.util.Iterator<Attribute> iterator()
iterator in interface java.lang.Iterable<Attribute>Entry add(Attribute... attributes) throws LdapException
attributes - The attributes to addLdapException - If we can't add any of the attributesEntry add(AttributeType attributeType, byte[]... values) throws LdapException
Add an attribute (represented by its AttributeType and some binary values) into an entry.
If we already have an attribute with the same values, the duplicated values are not added (duplicated values are not allowed)
If the value cannot be added, or if the AttributeType is null or invalid, a LdapException is thrown.
attributeType - The attribute Type.values - The list of binary values to inject. It can be empty.LdapException - If the attribute does not existEntry add(AttributeType attributeType, java.lang.String... values) throws LdapException
Add an attribute (represented by its AttributeType and some String values) into an entry.
If we already have an attribute with the same values, the duplicated values are not added (duplicated values are not allowed)
If the value cannot be added, or if the AttributeType is null or invalid, a LdapException is thrown.
attributeType - The attribute Typevalues - The list of binary values to inject. It can be emptyLdapException - If the attribute does not existEntry add(AttributeType attributeType, Value<?>... values) throws LdapException
Add an attribute (represented by its AttributeType and some values) into an entry.
If we already have an attribute with the same values, the duplicated values are not added (duplicated values are not allowed)
If the value cannot be added, or if the AttributeType is null or invalid, a LdapException is thrown.
attributeType - The attribute Typevalues - The list of binary values to inject. It can be emptyLdapException - If the attribute does not existEntry add(java.lang.String upId, AttributeType attributeType, byte[]... values) throws LdapException
Add an attribute (represented by its AttributeType and some binary values) into an entry. Set the User Provider ID at the same time
If we already have an attribute with the same values, the duplicated values are not added (duplicated values are not allowed)
If the value cannot be added, or if the AttributeType is null or invalid, a LdapException is thrown.
upId - The user provided ID for the added AttributeTypeattributeType - The attribute Type.values - The list of binary values to add. It can be empty.LdapException - If the attribute does not existEntry add(java.lang.String upId, AttributeType attributeType, java.lang.String... values) throws LdapException
Add an attribute (represented by its AttributeType and some String values) into an entry. Set the User Provider ID at the same time
If we already have an attribute with the same values, the duplicated values are not added (duplicated values are not allowed)
If the value cannot be added, or if the AttributeType is null or invalid, a LdapException is thrown.
upId - The user provided ID for the added AttributeTypeattributeType - The attribute Type.values - The list of String values to add. It can be empty.LdapException - If the attribute does not existEntry add(java.lang.String upId, AttributeType attributeType, Value<?>... values) throws LdapException
Add an attribute (represented by its AttributeType and some values) into an entry. Set the User Provider ID at the same time
If we already have an attribute with the same values, nothing is done (duplicated values are not allowed)
If the value cannot be added, or if the AttributeType is null or invalid, a LdapException is thrown.
upId - The user provided ID for the added AttributeTypeattributeType - The attribute Type.values - The list of values to add. It can be empty.LdapException - If the attribute does not existEntry add(java.lang.String upId, java.lang.String... values) throws LdapException
upId - The user provided ID of the attribute we want to add
some values tovalues - The list of String values to addLdapException - If we can't add any of the valuesEntry add(java.lang.String upId, byte[]... values) throws LdapException
upId - The user provided ID of the attribute we want to add
some values tovalues - The list of binary values to addLdapException - If we can't add any of the valuesEntry add(java.lang.String upId, Value<?>... values) throws LdapException
upId - The user provided ID of the attribute we want to add
some values tovalues - The list of Values to addLdapException - If we can't add any of the valuesjava.util.List<Attribute> put(Attribute... attributes) throws LdapException
Places attributes in the attribute collection.
If there is already an attribute with the same ID as any of the
new attributes, the old ones are removed from the collection and
are returned by this method. If there was no attribute with the
same ID the return value is null.
attributes - the attributes to be putnullLdapException - if the operation failsAttribute put(AttributeType attributeType, byte[]... values) throws LdapException
Places a new attribute with the supplied AttributeType and binary values into the attribute collection.
If there is already an attribute with the same AttributeType, the old one is removed from the collection and is returned by this method.
This method provides a mechanism to put an attribute with a
null value: the value may be null.
attributeType - the type of the new attribute to be putvalues - the binary values of the new attribute to be putnullLdapException - if there are failuresAttribute put(AttributeType attributeType, java.lang.String... values) throws LdapException
Places a new attribute with the supplied AttributeType and String values into the attribute collection.
If there is already an attribute with the same AttributeType, the old one is removed from the collection and is returned by this method.
This method provides a mechanism to put an attribute with a
null value: the value may be null.
attributeType - the type of the new attribute to be putvalues - the String values of the new attribute to be putnullLdapException - if there are failuresAttribute put(AttributeType attributeType, Value<?>... values) throws LdapException
Places a new attribute with the supplied AttributeType and some values into the attribute collection.
If there is already an attribute with the same AttributeType, the old one is removed from the collection and is returned by this method.
This method provides a mechanism to put an attribute with a
null value: the value may be null.
attributeType - the type of the new attribute to be putvalues - the values of the new attribute to be putnullLdapException - if there are failuresAttribute put(java.lang.String upId, AttributeType attributeType, byte[]... values) throws LdapException
Places a new attribute with the supplied AttributeType and some binary values into the attribute collection.
The given User provided ID will be used for this new AttributeEntry.
If there is already an attribute with the same AttributeType, the old one is removed from the collection and is returned by this method.
This method provides a mechanism to put an attribute with a
null value: the value may be null.
upId - The User Provided ID to be stored into the AttributeEntryvalues - the binary values of the new attribute to be putnullLdapException - if there are failures.Attribute put(java.lang.String upId, AttributeType attributeType, java.lang.String... values) throws LdapException
Places a new attribute with the supplied AttributeType and some String values into the attribute collection.
The given User provided ID will be used for this new AttributeEntry.
If there is already an attribute with the same AttributeType, the old one is removed from the collection and is returned by this method.
This method provides a mechanism to put an attribute with a
null value: the value may be null.
upId - The User Provided ID to be stored into the AttributeEntryattributeType - the type of the new attribute to be putvalues - the String values of the new attribute to be putnullLdapException - if there are failures.Attribute put(java.lang.String upId, AttributeType attributeType, Value<?>... values) throws LdapException
Places a new attribute with the supplied AttributeType and some values into the attribute collection.
The given User provided ID will be used for this new AttributeEntry.
If there is already an attribute with the same AttributeType, the old one is removed from the collection and is returned by this method.
This method provides a mechanism to put an attribute with a
null value: the value may be null.
upId - The User Provided ID to be stored into the AttributeEntryattributeType - the type of the new attribute to be putvalues - the values of the new attribute to be putnullLdapException - if there are failures.Attribute put(java.lang.String upId, byte[]... values)
Put an attribute (represented by its ID and some binary values) into an entry.
If the attribute already exists, the previous attribute will be replaced and returned.
upId - The attribute IDvalues - The list of binary values to put. It can be empty.Attribute put(java.lang.String upId, java.lang.String... values)
Put an attribute (represented by its ID and some String values) into an entry.
If the attribute already exists, the previous attribute will be replaced and returned.
upId - The attribute IDvalues - The list of String values to put. It can be empty.Attribute put(java.lang.String upId, Value<?>... values)
Put an attribute (represented by its ID and some values) into an entry.
If the attribute already exists, the previous attribute will be replaced and returned.
upId - The attribute IDvalues - The list of values to put. It can be empty.boolean remove(AttributeType attributeType, byte[]... values) throws LdapException
Removes the specified binary values from an attribute.
If at least one value is removed, this method returns true.
If there is no more value after having removed the values, the attribute will be removed too.
If the attribute does not exist, nothing is done and the method returns
false
attributeType - The attribute typevalues - the values to be removedtrue if at least a value is removed, false
if not all the values have been removed or if the attribute does not exist.LdapExceptionboolean remove(AttributeType attributeType, java.lang.String... values) throws LdapException
Removes the specified String values from an attribute.
If at least one value is removed, this method returns true.
If there is no more value after having removed the values, the attribute will be removed too.
If the attribute does not exist, nothing is done and the method returns
false
attributeType - The attribute typevalues - the values to be removedtrue if at least a value is removed, false
if not all the values have been removed or if the attribute does not exist.LdapExceptionboolean remove(AttributeType attributeType, Value<?>... values) throws LdapException
Removes the specified values from an attribute.
If at least one value is removed, this method returns true.
If there is no more value after having removed the values, the attribute will be removed too.
If the attribute does not exist, nothing is done and the method returns
false
attributeType - The attribute typevalues - the values to be removedtrue if at least a value is removed, false
if not all the values have been removed or if the attribute does not exist.LdapExceptionjava.util.List<Attribute> remove(Attribute... attributes) throws LdapException
null.attributes - the attributes to be removednullLdapExceptionvoid removeAttributes(AttributeType... attributes)
Removes the attribute with the specified AttributeTypes.
The removed attribute are returned by this method.
If there is no attribute with the specified AttributeTypes,
the return value is null.
attributes - the AttributeTypes to be removedboolean remove(java.lang.String upId,
byte[]... values)
throws LdapException
Removes the specified binary values from an attribute.
If at least one value is removed, this method returns true.
If there is no more value after having removed the values, the attribute will be removed too.
If the attribute does not exist, nothing is done and the method returns
false
upId - The attribute IDvalues - the attribute's values to be removedtrue if at least a value is removed, false
if not all the values have been removed or if the attribute does not exist.LdapExceptionboolean remove(java.lang.String upId,
java.lang.String... values)
throws LdapException
Removes the specified String values from an attribute.
If at least one value is removed, this method returns true.
If there is no more value after havong removed the values, the attribute will be removed too.
If the attribute does not exist, nothing is done and the method returns
false
upId - The attribute IDvalues - the attribute's values to be removedtrue if at least a value is removed, false
if no values have been removed or if the attribute does not exist.LdapExceptionboolean remove(java.lang.String upId,
Value<?>... values)
throws LdapException
Removes the specified values from an attribute.
If at least one value is removed, this method returns true.
If there is no more value after having removed the values, the attribute will be removed too.
If the attribute does not exist, nothing is done and the method returns
false
upId - The attribute IDvalues - the attribute's values to be removedtrue if at least a value is removed, false
if not all the values have been removed or if the attribute does not exist.LdapException - if the attribute does not existsvoid removeAttributes(java.lang.String... attributes)
Removes the attribute with the specified alias.
The removed attribute are returned by this method.
If there is no attribute with the specified alias,
the return value is null.
attributes - an aliased name of the attribute to be removedboolean contains(AttributeType attributeType, byte[]... values)
attributeType - The Attribute we are looking for.values - The searched binary values.true if all the values are found within the attribute,
false otherwise, or if the attributes does not exist.boolean contains(AttributeType attributeType, java.lang.String... values)
attributeType - The Attribute we are looking for.values - The searched String values.true if all the values are found within the attribute,
false otherwise, or if the attributes does not exist.boolean contains(AttributeType attributeType, Value<?>... values)
attributeType - The Attribute we are looking for.values - The searched values.true if all the values are found within the attribute,
false otherwise, or if the attributes does not exist.boolean containsAttribute(AttributeType attributeType)
attributeType - The AttributeType to look for.true if the attribute is found within the entry.boolean contains(Attribute... attributes)
Checks if an entry contains a list of attributes.
If the list is null or empty, this method will return true
if the entry has no attribute, false otherwise.
attributes - The Attributes to look fortrue if all the attributes are found within
the entry, false if at least one of them is not present.boolean contains(java.lang.String upId,
byte[]... values)
upId - The Attribute we are looking for.values - The searched values.true if all the values are found within the attribute,
false if at least one value is not present or if the ID is not valid.boolean contains(java.lang.String upId,
java.lang.String... values)
upId - The Attribute we are looking for.values - The searched values.true if all the values are found within the attribute,
false if at least one value is not present or if the ID is not valid.boolean contains(java.lang.String upId,
Value<?>... values)
upId - The Attribute we are looking for.values - The searched values.true if all the values are found within the attribute,
false if at least one value is not present or if the ID is not valid.boolean containsAttribute(java.lang.String... attributes)
attributes - The Attributes to look for.true if the attributes are all found within the entry.int size()
boolean isSchemaAware()
java.lang.String toString(java.lang.String tabs)
tabs - The tabs to add before any output