public final class DefaultEntry extends Object implements Entry
Constructor and Description |
---|
DefaultEntry()
Creates a new instance of DefaultEntry.
|
DefaultEntry(Dn dn)
Creates a new instance of DefaultEntry, with a Dn.
|
DefaultEntry(Dn dn,
Object... elements)
Creates a new instance of DefaultEntry, with a
Dn and a list of IDs.
|
DefaultEntry(SchemaManager schemaManager)
Creates a new instance of DefaultEntry, schema aware.
|
DefaultEntry(SchemaManager schemaManager,
Dn dn)
Creates a new instance of DefaultEntry, schema aware.
|
DefaultEntry(SchemaManager schemaManager,
Dn dn,
Object... elements)
Creates a new instance of DefaultEntry, with a
Dn and a list of IDs.
|
DefaultEntry(SchemaManager schemaManager,
Entry entry)
Creates a new instance of DefaultEntry, copying
another entry.
|
DefaultEntry(SchemaManager schemaManager,
String dn)
Creates a new instance of DefaultEntry, schema aware.
|
DefaultEntry(SchemaManager schemaManager,
String dn,
Object... elements)
Creates a new instance of DefaultEntry, with a
Dn and a list of IDs.
|
DefaultEntry(String dn)
Creates a new instance of DefaultEntry, with a Dn.
|
DefaultEntry(String dn,
Object... elements)
Creates a new instance of DefaultEntry, with a
Dn and a list of IDs.
|
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,
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(String upId,
AttributeType attributeType,
byte[]... values)
Add an attribute (represented by its AttributeType and some binary values) into an
entry.
|
Entry |
add(String upId,
AttributeType attributeType,
String... values)
Add an attribute (represented by its AttributeType and some String values) into an
entry.
|
Entry |
add(String upId,
AttributeType attributeType,
Value... values)
Add an attribute (represented by its AttributeType and some values) into an
entry.
|
Entry |
add(String upId,
byte[]... values)
Add some binary values to the current Entry.
|
Entry |
add(String upId,
String... values)
Add some String values to the current Entry.
|
Entry |
add(String upId,
Value... values)
Add some Values to the current Entry.
|
void |
clear()
Remove all the attributes for this entry.
|
Entry |
clone()
Clone an 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,
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(String upId,
byte[]... values)
Checks if an entry contains an attribute with some binary values.
|
boolean |
contains(String upId,
String... values)
Checks if an entry contains an attribute with some String values.
|
boolean |
contains(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(String... attributes)
Checks if an entry contains some specific attributes.
|
boolean |
equals(Object o) |
Attribute |
get(AttributeType attributeType)
Returns the attribute associated with an AttributeType
|
Attribute |
get(String alias)
Returns the attribute with the specified alias.
|
Collection<Attribute> |
getAttributes()
Gets all the attributes
|
Dn |
getDn()
Get this entry's Dn.
|
int |
hashCode()
Get the hash code of this ClientEntry.
|
boolean |
hasObjectClass(Attribute... objectClasses)
Tells if an entry has some specific ObjectClasses Attributes
|
boolean |
hasObjectClass(String... objectClasses)
Tells if an entry as some specific ObjectClasses values
|
boolean |
isSchemaAware()
Tells if the Entry is schema aware
|
Iterator<Attribute> |
iterator()
Returns an enumeration containing the zero or more attributes in the
collection.
|
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,
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(String upId,
AttributeType attributeType,
byte[]... values)
Places a new attribute with the supplied AttributeType and some binary values
into the attribute collection.
|
Attribute |
put(String upId,
AttributeType attributeType,
String... values)
Places a new attribute with the supplied AttributeType and some String values
into the attribute collection.
|
Attribute |
put(String upId,
AttributeType attributeType,
Value... values)
Places a new attribute with the supplied AttributeType and some values
into the attribute collection.
|
Attribute |
put(String upId,
byte[]... values)
Put an attribute (represented by its ID and some binary values) into an entry.
|
Attribute |
put(String upId,
String... values)
Put an attribute (represented by its ID and some String values) into an entry.
|
Attribute |
put(String upId,
Value... values)
Put an attribute (represented by its ID and some values) into an entry.
|
void |
readExternal(ObjectInput in) |
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,
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(String upId,
byte[]... values)
Removes the specified binary values from an attribute.
|
boolean |
remove(String upId,
String... values)
Removes the specified String values from an attribute.
|
boolean |
remove(String upId,
Value... values)
Removes the specified values from an attribute.
|
void |
removeAttributes(AttributeType... attributes)
Removes the attribute with the specified AttributeTypes.
|
void |
removeAttributes(String... attributes)
Removes the attribute with the specified alias.
|
void |
setDn(Dn dn)
Set this entry's Dn.
|
void |
setDn(String dn)
Set this entry's Dn.
|
Entry |
shallowClone()
Shallow clone an entry.
|
int |
size()
Returns the number of attributes.
|
String |
toString() |
String |
toString(String tabs)
A pretty-pinter for Entries
|
void |
writeExternal(ObjectOutput out)
This is the place where we serialize entries, and all theirs
elements.
|
forEach, spliterator
public DefaultEntry()
This entry must be initialized before being used !
public DefaultEntry(SchemaManager schemaManager)
Creates a new instance of DefaultEntry, schema aware.
No attributes will be created.
schemaManager
- The reference to the schemaManagerpublic DefaultEntry(String dn) throws LdapInvalidDnException
dn
- The String Dn for this serverEntry. Can be null.LdapInvalidDnException
- If the Dn is invalidpublic DefaultEntry(Dn dn)
dn
- The Dn for this serverEntry. Can be null.public DefaultEntry(SchemaManager schemaManager, String dn) throws LdapInvalidDnException
Creates a new instance of DefaultEntry, schema aware.
No attributes will be created.
schemaManager
- The reference to the schemaManagerdn
- The String Dn for this serverEntry. Can be null.LdapInvalidDnException
- If the Dn is invalidpublic DefaultEntry(SchemaManager schemaManager, Dn dn)
Creates a new instance of DefaultEntry, schema aware.
No attributes will be created.
schemaManager
- The reference to the schemaManagerdn
- The Dn for this serverEntry. Can be null.public DefaultEntry(String dn, Object... elements) throws LdapException
dn
- The Dn for this serverEntry. Can be null.elements
- The list of elements to inject in the entryLdapException
- If the elements are invalidLdapException
- If the provided Dn or elements are invalidpublic DefaultEntry(Dn dn, Object... elements) throws LdapException
dn
- The Dn for this serverEntry. Can be null.elements
- The list of attributes to create.LdapException
- If the provided Dn or elements are invalidpublic DefaultEntry(SchemaManager schemaManager, String dn, Object... elements) throws LdapException
schemaManager
- The SchemaManagerdn
- The Dn for this serverEntry. Can be null.elements
- The list of attributes to create.LdapException
- If the provided Dn or elements are invalidpublic DefaultEntry(SchemaManager schemaManager, Dn dn, Object... elements) throws LdapException
schemaManager
- The reference to the schemaManagerdn
- The Dn for this serverEntry. Can be null.elements
- The list of attributes to create.LdapException
- If the provided Dn or Elements are invalidpublic DefaultEntry(SchemaManager schemaManager, Entry entry) throws LdapException
Creates a new instance of DefaultEntry, copying another entry.
No attributes will be created.
schemaManager
- The reference to the schemaManagerentry
- the entry to copyLdapException
- If the provided entry is invalidpublic Entry 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.
add
in interface Entry
attributeType
- The attribute Type.values
- The list of binary values to inject. It can be empty.LdapException
- If the attribute does not existpublic Entry add(AttributeType attributeType, 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.
add
in interface Entry
attributeType
- The attribute Typevalues
- The list of binary values to inject. It can be emptyLdapException
- If the attribute does not existpublic Entry 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.
add
in interface Entry
attributeType
- The attribute Typevalues
- The list of binary values to inject. It can be emptyLdapException
- If the attribute does not existpublic Entry add(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.
add
in interface Entry
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 existpublic Entry add(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.
add
in interface Entry
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 existpublic Entry add(String upId, AttributeType attributeType, 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.
add
in interface Entry
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 existpublic Entry add(Attribute... attributes) throws LdapException
add
in interface Entry
attributes
- The attributes to addLdapException
- If we can't add any of the attributespublic Entry add(String upId, byte[]... values) throws LdapException
add
in interface Entry
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 valuespublic Entry add(String upId, String... values) throws LdapException
add
in interface Entry
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 valuespublic Entry add(String upId, Value... values) throws LdapException
add
in interface Entry
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 valuespublic Entry clone()
public Entry shallowClone()
shallowClone
in interface Entry
public 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.
public boolean containsAttribute(String... attributes)
containsAttribute
in interface Entry
attributes
- The Attributes to look for.true
if the attributes are all found within the entry.public boolean containsAttribute(AttributeType attributeType)
containsAttribute
in interface Entry
attributeType
- The AttributeType to look for.true
if the attribute is found within the entry.public boolean contains(AttributeType attributeType, byte[]... values)
public boolean contains(AttributeType attributeType, String... values)
public boolean contains(AttributeType attributeType, Value... values)
public boolean contains(String upId, byte[]... values)
public boolean contains(String upId, String... values)
public boolean contains(String upId, Value... values)
public Attribute get(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'.
public Attribute get(AttributeType attributeType)
public Collection<Attribute> getAttributes()
getAttributes
in interface Entry
public Attribute put(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.
public Attribute put(String upId, 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.
public Attribute put(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.
public 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
.
put
in interface Entry
attributes
- the attributes to be putnull
LdapException
- if the operation failspublic Attribute 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
.
put
in interface Entry
attributeType
- the type of the new attribute to be putvalues
- the binary values of the new attribute to be putnull
LdapException
- if there are failurespublic Attribute put(AttributeType attributeType, 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
.
put
in interface Entry
attributeType
- the type of the new attribute to be putvalues
- the String values of the new attribute to be putnull
LdapException
- if there are failurespublic Attribute 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
.
put
in interface Entry
attributeType
- the type of the new attribute to be putvalues
- the values of the new attribute to be putnull
LdapException
- if there are failurespublic Attribute put(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
.
put
in interface Entry
upId
- The User Provided ID to be stored into the AttributeEntryattributeType
- The attributeType to usevalues
- The values to storenull
LdapException
- if there are failures.public Attribute put(String upId, AttributeType attributeType, 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
.
put
in interface Entry
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 putnull
LdapException
- if there are failures.public Attribute put(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
.
put
in interface Entry
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 putnull
LdapException
- if there are failures.public List<Attribute> remove(Attribute... attributes) throws LdapException
null
.remove
in interface Entry
attributes
- the attributes to be removednull
LdapException
- If the removal failedpublic 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
remove
in interface Entry
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.LdapException
- If the removal failedpublic boolean remove(AttributeType attributeType, 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
remove
in interface Entry
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.LdapException
- If the removal failedpublic boolean 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
remove
in interface Entry
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.LdapException
- If the removal failedpublic void 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
.
removeAttributes
in interface Entry
attributes
- the AttributeTypes to be removedpublic void removeAttributes(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
.
removeAttributes
in interface Entry
attributes
- an aliased name of the attribute to be removedpublic boolean remove(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
remove
in interface Entry
upId
- The attribute IDvalues
- 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.LdapException
- If the removal failedpublic boolean remove(String upId, 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
remove
in interface Entry
upId
- The attribute IDvalues
- the attributes 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 provided values are invalidpublic boolean remove(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
remove
in interface Entry
upId
- The attribute IDvalues
- the attributes 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 existspublic void setDn(String dn) throws LdapInvalidDnException
setDn
in interface Entry
dn
- The String Dn associated with this entryLdapInvalidDnException
- if the provided Dn is invalidpublic void clear()
public Iterator<Attribute> iterator()
public int size()
public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
public int hashCode()
hashCode
in class Object
Object.hashCode()
public boolean hasObjectClass(String... objectClasses)
hasObjectClass
in interface Entry
objectClasses
- The ObjectClasses we want to checktrue
if all the ObjectClasses value are present
in the ObjectClass attributepublic boolean hasObjectClass(Attribute... objectClasses)
hasObjectClass
in interface Entry
objectClasses
- The ObjectClasses we want to checktrue
if the ObjectClasses Attribute are present
in the ObjectClass attributepublic boolean isSchemaAware()
isSchemaAware
in interface Entry
public boolean equals(Object o)
equals
in class Object
Object.equals(Object)
public String toString()
toString
in class Object
Object.toString()
Copyright © 2003–2020 The Apache Software Foundation. All rights reserved.