public interface DirContextOperations extends DirContext, AttributeModificationsAware
DirContextAdapter
ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE
APPLET, AUTHORITATIVE, BATCHSIZE, DNS_URL, INITIAL_CONTEXT_FACTORY, LANGUAGE, OBJECT_FACTORIES, PROVIDER_URL, REFERRAL, SECURITY_AUTHENTICATION, SECURITY_CREDENTIALS, SECURITY_PRINCIPAL, SECURITY_PROTOCOL, STATE_FACTORIES, URL_PKG_PREFIXES
Modifier and Type | Method and Description |
---|---|
void |
addAttributeValue(String name,
Object value)
Add a value to the Attribute with the specified name.
|
void |
addAttributeValue(String name,
Object value,
boolean addIfDuplicateExists)
Add a value to the Attribute with the specified name.
|
boolean |
attributeExists(String name)
Check if an Object attribute exists, regardless of whether it has a value
or not.
|
Attributes |
getAttributes()
Get all the Attributes.
|
SortedSet |
getAttributeSortedStringSet(String name)
Get all String values of the attribute as a
SortedSet . |
Name |
getDn()
Returns the DN relative to the base path.
|
String |
getNameInNamespace() |
String[] |
getNamesOfModifiedAttributes()
Creates a String array of the names of the attributes which have been
changed.
|
Object |
getObjectAttribute(String name)
Get the value of an Object attribute.
|
Object[] |
getObjectAttributes(String name)
Get all values of an Object attribute.
|
String |
getReferralUrl()
If this instance results from a referral, this method returns the url of
the referred server.
|
String |
getStringAttribute(String name)
Get the value of a String attribute.
|
String[] |
getStringAttributes(String name)
Get all values of a String attribute.
|
boolean |
isReferral()
Checks whether this instance results from a referral.
|
boolean |
isUpdateMode()
Gets the update mode.
|
void |
removeAttributeValue(String name,
Object value)
Remove a value from the Attribute with the specified name.
|
void |
setAttributeValue(String name,
Object value)
Set the with the name
name to the value . |
void |
setAttributeValues(String name,
Object[] values)
Sets a multivalue attribute, disregarding the order of the values.
|
void |
setAttributeValues(String name,
Object[] values,
boolean orderMatters)
Sets a multivalue attribute.
|
void |
setDn(Name dn)
Set the dn of this entry.
|
void |
update()
Update the attributes.This will mean that the getters (
getStringAttribute methods) will return the updated values,
and the modifications will be forgotten (i.e. |
bind, bind, createSubcontext, createSubcontext, getAttributes, getAttributes, getAttributes, getAttributes, getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, rebind, rebind, search, search, search, search, search, search, search, search
addToEnvironment, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, getEnvironment, getNameParser, getNameParser, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbind
getModificationItems
boolean isUpdateMode()
AttributeModificationsAware.getModificationItems()
. The update
mode should be true
for a new entry and true
for an existing entry that is being updated.String[] getNamesOfModifiedAttributes()
String getStringAttribute(String name)
null
will be returned.name
- name of the attribute.null
if
the attribute doesn't exist or if it exists but with no value.ClassCastException
- if the value of the entry is not a String.Object getObjectAttribute(String name)
null
will be returned.name
- name of the attribute.null
if the attribute doesn't exist or if it exists but with
no value.boolean attributeExists(String name)
name
- name of the attributetrue
if the attribute exists, false
otherwisevoid setAttributeValue(String name, Object value)
name
to the value
.name
- name of the attribute.value
- value to set the attribute to.void setAttributeValues(String name, Object[] values)
name
- The id of the attribute.values
- Attribute values.void setAttributeValues(String name, Object[] values, boolean orderMatters)
name
- The id of the attribute.values
- Attribute values.orderMatters
- If true
, it will be changed even if data
was just reordered.void addAttributeValue(String name, Object value)
name
- the name of the Attribute to which the specified value should
be added.value
- the Attribute value to add.void addAttributeValue(String name, Object value, boolean addIfDuplicateExists)
addIfDuplicateExists
parameter controls the handling of duplicates. It false
,
this method makes sure that the there will be no duplicates of an added
value - it the value exists it will not be added again.name
- the name of the Attribute to which the specified value should
be added.value
- the Attribute value to add.addIfDuplicateExists
- true
will add the value
regardless of whether there is an identical value already, allowing for
duplicate attribute values; false
will not add the value if
it already exists.void removeAttributeValue(String name, Object value)
name
- the name of the Attribute from which the specified value
should be removed.value
- the value to remove.void update()
getStringAttribute
methods) will return the updated values,
and the modifications will be forgotten (i.e.
AttributeModificationsAware.getModificationItems()
will return an
empty array.String[] getStringAttributes(String name)
name
- name of the attribute.null
otherwise.ArrayStoreException
- if any of the attribute values is not a
String.Object[] getObjectAttributes(String name)
name
- name of the attribute.null
otherwise.SortedSet getAttributeSortedStringSet(String name)
SortedSet
.name
- name of the attribute.SortedSet
containing all values of the attribute,
or null
if the attribute does not exist.Name getDn()
DirContextAdapter.getNameInNamespace()
void setDn(Name dn)
dn
- the dn.String getNameInNamespace()
getNameInNamespace
in interface Context
String getReferralUrl()
ldap://localhost:389
, or the empty string if this is not a
referral.boolean isReferral()
true
if this instance results from a referral,
false
otherwise.Attributes getAttributes()
Copyright © 2005-2012 The Spring LDAP Framework. All Rights Reserved.