Class BaseDirContext
- java.lang.Object
-
- org.apache.naming.resources.BaseDirContext
-
- All Implemented Interfaces:
Context
,DirContext
- Direct Known Subclasses:
FileDirContext
,WARDirContext
public abstract class BaseDirContext extends Object implements DirContext
Directory Context implementation helper class.- Version:
- $Revision: 1.3 $ $Date: 2005/12/08 01:29:08 $
- Author:
- Remy Maucherat
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
cached
Cached.protected int
cacheMaxSize
Max size of resources which will have their content cached.protected int
cacheTTL
Cache TTL.protected int
debug
The debugging detail level for this component.protected String
docBase
The document base path.protected Hashtable<String,Object>
env
Environment.-
Fields inherited from interface javax.naming.Context
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
-
Fields inherited from interface javax.naming.directory.DirContext
ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE
-
-
Constructor Summary
Constructors Constructor Description BaseDirContext()
Builds a base directory context.BaseDirContext(Hashtable<String,Object> env)
Builds a base directory context using the given environment.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Object
addToEnvironment(String propName, Object propVal)
Adds a new environment property to the environment of this context.void
allocate()
Allocate resources for this directory context.void
bind(String name, Object obj)
Binds a name to an object.abstract void
bind(String name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes.void
bind(Name name, Object obj)
Binds a name to an object.void
bind(Name name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes.void
close()
Closes this context.String
composeName(String name, String prefix)
Composes the name of this context with a name relative to this context.Name
composeName(Name name, Name prefix)
Composes the name of this context with a name relative to this context.Context
createSubcontext(String name)
Creates and binds a new context.abstract DirContext
createSubcontext(String name, Attributes attrs)
Creates and binds a new context, along with associated attributes.Context
createSubcontext(Name name)
Creates and binds a new context.DirContext
createSubcontext(Name name, Attributes attrs)
Creates and binds a new context, along with associated attributes.abstract void
destroySubcontext(String name)
Destroys the named context and removes it from the namespace.void
destroySubcontext(Name name)
Destroys the named context and removes it from the namespace.Attributes
getAttributes(String name)
Retrieves all of the attributes associated with a named object.abstract Attributes
getAttributes(String name, String[] attrIds)
Retrieves selected attributes associated with a named object.Attributes
getAttributes(Name name)
Retrieves all of the attributes associated with a named object.Attributes
getAttributes(Name name, String[] attrIds)
Retrieves selected attributes associated with a named object.int
getCacheMaxSize()
Return the maximum size of the cache in KB.int
getCacheTTL()
Get cache TTL.int
getDebug()
Return the debugging detail level for this component.String
getDocBase()
Return the document root for this component.Hashtable<String,Object>
getEnvironment()
Retrieves the environment in effect for this context.abstract String
getNameInNamespace()
Retrieves the full name of this context within its own namespace.NameParser
getNameParser(String name)
Retrieves the parser associated with the named context.NameParser
getNameParser(Name name)
Retrieves the parser associated with the named context.abstract DirContext
getSchema(String name)
Retrieves the schema associated with the named object.DirContext
getSchema(Name name)
Retrieves the schema associated with the named object.abstract DirContext
getSchemaClassDefinition(String name)
Retrieves a context containing the schema objects of the named object's class definitions.DirContext
getSchemaClassDefinition(Name name)
Retrieves a context containing the schema objects of the named object's class definitions.boolean
isCached()
Is cached ?abstract NamingEnumeration<NameClassPair>
list(String name)
Enumerates the names bound in the named context, along with the class names of objects bound to them.NamingEnumeration<NameClassPair>
list(Name name)
Enumerates the names bound in the named context, along with the class names of objects bound to them.abstract NamingEnumeration<Binding>
listBindings(String name)
Enumerates the names bound in the named context, along with the objects bound to them.NamingEnumeration<Binding>
listBindings(Name name)
Enumerates the names bound in the named context, along with the objects bound to them.abstract Object
lookup(String name)
Retrieves the named object.Object
lookup(Name name)
Retrieves the named object.abstract Object
lookupLink(String name)
Retrieves the named object, following links except for the terminal atomic component of the name.Object
lookupLink(Name name)
Retrieves the named object, following links except for the terminal atomic component of the name.abstract void
modifyAttributes(String name, int mod_op, Attributes attrs)
Modifies the attributes associated with a named object.abstract void
modifyAttributes(String name, ModificationItem[] mods)
Modifies the attributes associated with a named object using an an ordered list of modifications.void
modifyAttributes(Name name, int mod_op, Attributes attrs)
Modifies the attributes associated with a named object.void
modifyAttributes(Name name, ModificationItem[] mods)
Modifies the attributes associated with a named object using an an ordered list of modifications.void
rebind(String name, Object obj)
Binds a name to an object, overwriting any existing binding.abstract void
rebind(String name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes, overwriting any existing binding.void
rebind(Name name, Object obj)
Binds a name to an object, overwriting any existing binding.void
rebind(Name name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes, overwriting any existing binding.void
release()
Release any resources allocated for this directory context.Object
removeFromEnvironment(String propName)
Removes an environment property from the environment of this context.abstract void
rename(String oldName, String newName)
Binds a new name to the object bound to an old name, and unbinds the old name.void
rename(Name oldName, Name newName)
Binds a new name to the object bound to an old name, and unbinds the old name.abstract NamingEnumeration<SearchResult>
search(String name, String filterExpr, Object[] filterArgs, SearchControls cons)
Searches in the named context or object for entries that satisfy the given search filter.abstract NamingEnumeration<SearchResult>
search(String name, String filter, SearchControls cons)
Searches in the named context or object for entries that satisfy the given search filter.abstract NamingEnumeration<SearchResult>
search(String name, Attributes matchingAttributes)
Searches in a single context for objects that contain a specified set of attributes.abstract NamingEnumeration<SearchResult>
search(String name, Attributes matchingAttributes, String[] attributesToReturn)
Searches in a single context for objects that contain a specified set of attributes, and retrieves selected attributes.NamingEnumeration<SearchResult>
search(Name name, String filterExpr, Object[] filterArgs, SearchControls cons)
Searches in the named context or object for entries that satisfy the given search filter.NamingEnumeration<SearchResult>
search(Name name, String filter, SearchControls cons)
Searches in the named context or object for entries that satisfy the given search filter.NamingEnumeration<SearchResult>
search(Name name, Attributes matchingAttributes)
Searches in a single context for objects that contain a specified set of attributes.NamingEnumeration<SearchResult>
search(Name name, Attributes matchingAttributes, String[] attributesToReturn)
Searches in a single context for objects that contain a specified set of attributes, and retrieves selected attributes.void
setCached(boolean cached)
Set cached.void
setCacheMaxSize(int cacheMaxSize)
Set the maximum size of the cache in KB.void
setCacheTTL(int cacheTTL)
Set cache TTL.void
setDebug(int debug)
Set the debugging detail level for this component.void
setDocBase(String docBase)
Set the document root for this component.abstract void
unbind(String name)
Unbinds the named object.void
unbind(Name name)
Unbinds the named object.
-
-
-
Field Detail
-
debug
protected int debug
The debugging detail level for this component.
-
docBase
protected String docBase
The document base path.
-
cached
protected boolean cached
Cached.
-
cacheTTL
protected int cacheTTL
Cache TTL.
-
cacheMaxSize
protected int cacheMaxSize
Max size of resources which will have their content cached.
-
-
Method Detail
-
getDebug
public int getDebug()
Return the debugging detail level for this component.
-
setDebug
public void setDebug(int debug)
Set the debugging detail level for this component.- Parameters:
debug
- The new debugging detail level
-
getDocBase
public String getDocBase()
Return the document root for this component.
-
setDocBase
public void setDocBase(String docBase)
Set the document root for this component.- Parameters:
docBase
- The new document root- Throws:
IllegalArgumentException
- if the specified value is not supported by this implementationIllegalArgumentException
- if this would create a malformed URL
-
setCached
public void setCached(boolean cached)
Set cached.
-
isCached
public boolean isCached()
Is cached ?
-
setCacheTTL
public void setCacheTTL(int cacheTTL)
Set cache TTL.
-
getCacheTTL
public int getCacheTTL()
Get cache TTL.
-
getCacheMaxSize
public int getCacheMaxSize()
Return the maximum size of the cache in KB.
-
setCacheMaxSize
public void setCacheMaxSize(int cacheMaxSize)
Set the maximum size of the cache in KB.
-
allocate
public void allocate()
Allocate resources for this directory context.
-
release
public void release()
Release any resources allocated for this directory context.
-
lookup
public Object lookup(Name name) throws NamingException
Retrieves the named object. If name is empty, returns a new instance of this context (which represents the same naming context as this context, but its environment may be modified independently and it may be accessed concurrently).- Specified by:
lookup
in interfaceContext
- Parameters:
name
- the name of the object to look up- Returns:
- the object bound to name
- Throws:
NamingException
- if a naming exception is encountered
-
lookup
public abstract Object lookup(String name) throws NamingException
Retrieves the named object.- Specified by:
lookup
in interfaceContext
- Parameters:
name
- the name of the object to look up- Returns:
- the object bound to name
- Throws:
NamingException
- if a naming exception is encountered
-
bind
public void bind(Name name, Object obj) throws NamingException
Binds a name to an object. All intermediate contexts and the target context (that named by all but terminal atomic component of the name) must already exist.- Specified by:
bind
in interfaceContext
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null- Throws:
NameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encountered
-
bind
public void bind(String name, Object obj) throws NamingException
Binds a name to an object.- Specified by:
bind
in interfaceContext
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null- Throws:
NameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encountered
-
rebind
public void rebind(Name name, Object obj) throws NamingException
Binds a name to an object, overwriting any existing binding. All intermediate contexts and the target context (that named by all but terminal atomic component of the name) must already exist.If the object is a DirContext, any existing attributes associated with the name are replaced with those of the object. Otherwise, any existing attributes associated with the name remain unchanged.
- Specified by:
rebind
in interfaceContext
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null- Throws:
InvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encountered
-
rebind
public void rebind(String name, Object obj) throws NamingException
Binds a name to an object, overwriting any existing binding.- Specified by:
rebind
in interfaceContext
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null- Throws:
InvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encountered
-
unbind
public void unbind(Name name) throws NamingException
Unbinds the named object. Removes the terminal atomic name in name from the target context--that named by all but the terminal atomic part of name.This method is idempotent. It succeeds even if the terminal atomic name is not bound in the target context, but throws NameNotFoundException if any of the intermediate contexts do not exist.
- Specified by:
unbind
in interfaceContext
- Parameters:
name
- the name to bind; may not be empty- Throws:
NameNotFoundException
- if an intermediate context does not existNamingException
- if a naming exception is encountered
-
unbind
public abstract void unbind(String name) throws NamingException
Unbinds the named object.- Specified by:
unbind
in interfaceContext
- Parameters:
name
- the name to bind; may not be empty- Throws:
NameNotFoundException
- if an intermediate context does not existNamingException
- if a naming exception is encountered
-
rename
public void rename(Name oldName, Name newName) throws NamingException
Binds a new name to the object bound to an old name, and unbinds the old name. Both names are relative to this context. Any attributes associated with the old name become associated with the new name. Intermediate contexts of the old name are not changed.- Specified by:
rename
in interfaceContext
- Parameters:
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be empty- Throws:
NameAlreadyBoundException
- if newName is already boundNamingException
- if a naming exception is encountered
-
rename
public abstract void rename(String oldName, String newName) throws NamingException
Binds a new name to the object bound to an old name, and unbinds the old name.- Specified by:
rename
in interfaceContext
- Parameters:
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be empty- Throws:
NameAlreadyBoundException
- if newName is already boundNamingException
- if a naming exception is encountered
-
list
public NamingEnumeration<NameClassPair> list(Name name) throws NamingException
Enumerates the names bound in the named context, along with the class names of objects bound to them. The contents of any subcontexts are not included.If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
- Specified by:
list
in interfaceContext
- Parameters:
name
- the name of the context to list- Returns:
- an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
- Throws:
NamingException
- if a naming exception is encountered
-
list
public abstract NamingEnumeration<NameClassPair> list(String name) throws NamingException
Enumerates the names bound in the named context, along with the class names of objects bound to them.- Specified by:
list
in interfaceContext
- Parameters:
name
- the name of the context to list- Returns:
- an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
- Throws:
NamingException
- if a naming exception is encountered
-
listBindings
public NamingEnumeration<Binding> listBindings(Name name) throws NamingException
Enumerates the names bound in the named context, along with the objects bound to them. The contents of any subcontexts are not included.If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
- Specified by:
listBindings
in interfaceContext
- Parameters:
name
- the name of the context to list- Returns:
- an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
- Throws:
NamingException
- if a naming exception is encountered
-
listBindings
public abstract NamingEnumeration<Binding> listBindings(String name) throws NamingException
Enumerates the names bound in the named context, along with the objects bound to them.- Specified by:
listBindings
in interfaceContext
- Parameters:
name
- the name of the context to list- Returns:
- an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
- Throws:
NamingException
- if a naming exception is encountered
-
destroySubcontext
public void destroySubcontext(Name name) throws NamingException
Destroys the named context and removes it from the namespace. Any attributes associated with the name are also removed. Intermediate contexts are not destroyed.This method is idempotent. It succeeds even if the terminal atomic name is not bound in the target context, but throws NameNotFoundException if any of the intermediate contexts do not exist. In a federated naming system, a context from one naming system may be bound to a name in another. One can subsequently look up and perform operations on the foreign context using a composite name. However, an attempt destroy the context using this composite name will fail with NotContextException, because the foreign context is not a "subcontext" of the context in which it is bound. Instead, use unbind() to remove the binding of the foreign context. Destroying the foreign context requires that the destroySubcontext() be performed on a context from the foreign context's "native" naming system.
- Specified by:
destroySubcontext
in interfaceContext
- Parameters:
name
- the name of the context to be destroyed; may not be empty- Throws:
NameNotFoundException
- if an intermediate context does not existNotContextException
- if the name is bound but does not name a context, or does not name a context of the appropriate typeNamingException
-
destroySubcontext
public abstract void destroySubcontext(String name) throws NamingException
Destroys the named context and removes it from the namespace.- Specified by:
destroySubcontext
in interfaceContext
- Parameters:
name
- the name of the context to be destroyed; may not be empty- Throws:
NameNotFoundException
- if an intermediate context does not existNotContextException
- if the name is bound but does not name a context, or does not name a context of the appropriate typeNamingException
-
createSubcontext
public Context createSubcontext(Name name) throws NamingException
Creates and binds a new context. Creates a new context with the given name and binds it in the target context (that named by all but terminal atomic component of the name). All intermediate contexts and the target context must already exist.- Specified by:
createSubcontext
in interfaceContext
- Parameters:
name
- the name of the context to create; may not be empty- Returns:
- the newly created context
- Throws:
NameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if creation of the subcontext requires specification of mandatory attributesNamingException
- if a naming exception is encountered
-
createSubcontext
public Context createSubcontext(String name) throws NamingException
Creates and binds a new context.- Specified by:
createSubcontext
in interfaceContext
- Parameters:
name
- the name of the context to create; may not be empty- Returns:
- the newly created context
- Throws:
NameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if creation of the subcontext requires specification of mandatory attributesNamingException
- if a naming exception is encountered
-
lookupLink
public Object lookupLink(Name name) throws NamingException
Retrieves the named object, following links except for the terminal atomic component of the name. If the object bound to name is not a link, returns the object itself.- Specified by:
lookupLink
in interfaceContext
- Parameters:
name
- the name of the object to look up- Returns:
- the object bound to name, not following the terminal link (if any).
- Throws:
NamingException
- if a naming exception is encountered
-
lookupLink
public abstract Object lookupLink(String name) throws NamingException
Retrieves the named object, following links except for the terminal atomic component of the name.- Specified by:
lookupLink
in interfaceContext
- Parameters:
name
- the name of the object to look up- Returns:
- the object bound to name, not following the terminal link (if any).
- Throws:
NamingException
- if a naming exception is encountered
-
getNameParser
public NameParser getNameParser(Name name) throws NamingException
Retrieves the parser associated with the named context. In a federation of namespaces, different naming systems will parse names differently. This method allows an application to get a parser for parsing names into their atomic components using the naming convention of a particular naming system. Within any single naming system, NameParser objects returned by this method must be equal (using the equals() test).- Specified by:
getNameParser
in interfaceContext
- Parameters:
name
- the name of the context from which to get the parser- Returns:
- a name parser that can parse compound names into their atomic components
- Throws:
NamingException
- if a naming exception is encountered
-
getNameParser
public NameParser getNameParser(String name) throws NamingException
Retrieves the parser associated with the named context.- Specified by:
getNameParser
in interfaceContext
- Parameters:
name
- the name of the context from which to get the parser- Returns:
- a name parser that can parse compound names into their atomic components
- Throws:
NamingException
- if a naming exception is encountered
-
composeName
public Name composeName(Name name, Name prefix) throws NamingException
Composes the name of this context with a name relative to this context.Given a name (name) relative to this context, and the name (prefix) of this context relative to one of its ancestors, this method returns the composition of the two names using the syntax appropriate for the naming system(s) involved. That is, if name names an object relative to this context, the result is the name of the same object, but relative to the ancestor context. None of the names may be null.
- Specified by:
composeName
in interfaceContext
- Parameters:
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestors- Returns:
- the composition of prefix and name
- Throws:
NamingException
- if a naming exception is encountered
-
composeName
public String composeName(String name, String prefix) throws NamingException
Composes the name of this context with a name relative to this context.- Specified by:
composeName
in interfaceContext
- Parameters:
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestors- Returns:
- the composition of prefix and name
- Throws:
NamingException
- if a naming exception is encountered
-
addToEnvironment
public Object addToEnvironment(String propName, Object propVal) throws NamingException
Adds a new environment property to the environment of this context. If the property already exists, its value is overwritten.- Specified by:
addToEnvironment
in interfaceContext
- Parameters:
propName
- the name of the environment property to add; may not be nullpropVal
- the value of the property to add; may not be null- Throws:
NamingException
- if a naming exception is encountered
-
removeFromEnvironment
public Object removeFromEnvironment(String propName) throws NamingException
Removes an environment property from the environment of this context.- Specified by:
removeFromEnvironment
in interfaceContext
- Parameters:
propName
- the name of the environment property to remove; may not be null- Throws:
NamingException
- if a naming exception is encountered
-
getEnvironment
public Hashtable<String,Object> getEnvironment() throws NamingException
Retrieves the environment in effect for this context. See class description for more details on environment properties. The caller should not make any changes to the object returned: their effect on the context is undefined. The environment of this context may be changed using addToEnvironment() and removeFromEnvironment().- Specified by:
getEnvironment
in interfaceContext
- Returns:
- the environment of this context; never null
- Throws:
NamingException
- if a naming exception is encountered
-
close
public void close() throws NamingException
Closes this context. This method releases this context's resources immediately, instead of waiting for them to be released automatically by the garbage collector. This method is idempotent: invoking it on a context that has already been closed has no effect. Invoking any other method on a closed context is not allowed, and results in undefined behaviour.- Specified by:
close
in interfaceContext
- Throws:
NamingException
- if a naming exception is encountered
-
getNameInNamespace
public abstract String getNameInNamespace() throws NamingException
Retrieves the full name of this context within its own namespace.Many naming services have a notion of a "full name" for objects in their respective namespaces. For example, an LDAP entry has a distinguished name, and a DNS record has a fully qualified name. This method allows the client application to retrieve this name. The string returned by this method is not a JNDI composite name and should not be passed directly to context methods. In naming systems for which the notion of full name does not make sense, OperationNotSupportedException is thrown.
- Specified by:
getNameInNamespace
in interfaceContext
- Returns:
- this context's name in its own namespace; never null
- Throws:
OperationNotSupportedException
- if the naming system does not have the notion of a full nameNamingException
- if a naming exception is encountered
-
getAttributes
public Attributes getAttributes(Name name) throws NamingException
Retrieves all of the attributes associated with a named object.- Specified by:
getAttributes
in interfaceDirContext
- Parameters:
name
- the name of the object from which to retrieve attributes- Returns:
- the set of attributes associated with name. Returns an empty attribute set if name has no attributes; never null.
- Throws:
NamingException
- if a naming exception is encountered
-
getAttributes
public Attributes getAttributes(String name) throws NamingException
Retrieves all of the attributes associated with a named object.- Specified by:
getAttributes
in interfaceDirContext
- Parameters:
name
- the name of the object from which to retrieve attributes- Returns:
- the set of attributes associated with name
- Throws:
NamingException
- if a naming exception is encountered
-
getAttributes
public Attributes getAttributes(Name name, String[] attrIds) throws NamingException
Retrieves selected attributes associated with a named object. See the class description regarding attribute models, attribute type names, and operational attributes.- Specified by:
getAttributes
in interfaceDirContext
- Parameters:
name
- the name of the object from which to retrieve attributesattrIds
- the identifiers of the attributes to retrieve. null indicates that all attributes should be retrieved; an empty array indicates that none should be retrieved- Returns:
- the requested attributes; never null
- Throws:
NamingException
- if a naming exception is encountered
-
getAttributes
public abstract Attributes getAttributes(String name, String[] attrIds) throws NamingException
Retrieves selected attributes associated with a named object.- Specified by:
getAttributes
in interfaceDirContext
- Parameters:
name
- the name of the object from which to retrieve attributesattrIds
- the identifiers of the attributes to retrieve. null indicates that all attributes should be retrieved; an empty array indicates that none should be retrieved- Returns:
- the requested attributes; never null
- Throws:
NamingException
- if a naming exception is encountered
-
modifyAttributes
public void modifyAttributes(Name name, int mod_op, Attributes attrs) throws NamingException
Modifies the attributes associated with a named object. The order of the modifications is not specified. Where possible, the modifications are performed atomically.- Specified by:
modifyAttributes
in interfaceDirContext
- Parameters:
name
- the name of the object whose attributes will be updatedmod_op
- the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTEattrs
- the attributes to be used for the modification; may not be null- Throws:
AttributeModificationException
- if the modification cannot be completed successfullyNamingException
- if a naming exception is encountered
-
modifyAttributes
public abstract void modifyAttributes(String name, int mod_op, Attributes attrs) throws NamingException
Modifies the attributes associated with a named object.- Specified by:
modifyAttributes
in interfaceDirContext
- Parameters:
name
- the name of the object whose attributes will be updatedmod_op
- the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTEattrs
- the attributes to be used for the modification; may not be null- Throws:
AttributeModificationException
- if the modification cannot be completed successfullyNamingException
- if a naming exception is encountered
-
modifyAttributes
public void modifyAttributes(Name name, ModificationItem[] mods) throws NamingException
Modifies the attributes associated with a named object using an an ordered list of modifications. The modifications are performed in the order specified. Each modification specifies a modification operation code and an attribute on which to operate. Where possible, the modifications are performed atomically.- Specified by:
modifyAttributes
in interfaceDirContext
- Parameters:
name
- the name of the object whose attributes will be updatedmods
- an ordered sequence of modifications to be performed; may not be null- Throws:
AttributeModificationException
- if the modification cannot be completed successfullyNamingException
- if a naming exception is encountered
-
modifyAttributes
public abstract void modifyAttributes(String name, ModificationItem[] mods) throws NamingException
Modifies the attributes associated with a named object using an an ordered list of modifications.- Specified by:
modifyAttributes
in interfaceDirContext
- Parameters:
name
- the name of the object whose attributes will be updatedmods
- an ordered sequence of modifications to be performed; may not be null- Throws:
AttributeModificationException
- if the modification cannot be completed successfullyNamingException
- if a naming exception is encountered
-
bind
public void bind(Name name, Object obj, Attributes attrs) throws NamingException
Binds a name to an object, along with associated attributes. If attrs is null, the resulting binding will have the attributes associated with obj if obj is a DirContext, and no attributes otherwise. If attrs is non-null, the resulting binding will have attrs as its attributes; any attributes associated with obj are ignored.- Specified by:
bind
in interfaceDirContext
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullattrs
- the attributes to associate with the binding- Throws:
NameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if some "mandatory" attributes of the binding are not suppliedNamingException
- if a naming exception is encountered
-
bind
public abstract void bind(String name, Object obj, Attributes attrs) throws NamingException
Binds a name to an object, along with associated attributes.- Specified by:
bind
in interfaceDirContext
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullattrs
- the attributes to associate with the binding- Throws:
NameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if some "mandatory" attributes of the binding are not suppliedNamingException
- if a naming exception is encountered
-
rebind
public void rebind(Name name, Object obj, Attributes attrs) throws NamingException
Binds a name to an object, along with associated attributes, overwriting any existing binding. If attrs is null and obj is a DirContext, the attributes from obj are used. If attrs is null and obj is not a DirContext, any existing attributes associated with the object already bound in the directory remain unchanged. If attrs is non-null, any existing attributes associated with the object already bound in the directory are removed and attrs is associated with the named object. If obj is a DirContext and attrs is non-null, the attributes of obj are ignored.- Specified by:
rebind
in interfaceDirContext
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullattrs
- the attributes to associate with the binding- Throws:
InvalidAttributesException
- if some "mandatory" attributes of the binding are not suppliedNamingException
- if a naming exception is encountered
-
rebind
public abstract void rebind(String name, Object obj, Attributes attrs) throws NamingException
Binds a name to an object, along with associated attributes, overwriting any existing binding.- Specified by:
rebind
in interfaceDirContext
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullattrs
- the attributes to associate with the binding- Throws:
InvalidAttributesException
- if some "mandatory" attributes of the binding are not suppliedNamingException
- if a naming exception is encountered
-
createSubcontext
public DirContext createSubcontext(Name name, Attributes attrs) throws NamingException
Creates and binds a new context, along with associated attributes. This method creates a new subcontext with the given name, binds it in the target context (that named by all but terminal atomic component of the name), and associates the supplied attributes with the newly created object. All intermediate and target contexts must already exist. If attrs is null, this method is equivalent to Context.createSubcontext().- Specified by:
createSubcontext
in interfaceDirContext
- Parameters:
name
- the name of the context to create; may not be emptyattrs
- the attributes to associate with the newly created context- Returns:
- the newly created context
- Throws:
NameAlreadyBoundException
- if the name is already boundInvalidAttributesException
- if attrs does not contain all the mandatory attributes required for creationNamingException
- if a naming exception is encountered
-
createSubcontext
public abstract DirContext createSubcontext(String name, Attributes attrs) throws NamingException
Creates and binds a new context, along with associated attributes.- Specified by:
createSubcontext
in interfaceDirContext
- Parameters:
name
- the name of the context to create; may not be emptyattrs
- the attributes to associate with the newly created context- Returns:
- the newly created context
- Throws:
NameAlreadyBoundException
- if the name is already boundInvalidAttributesException
- if attrs does not contain all the mandatory attributes required for creationNamingException
- if a naming exception is encountered
-
getSchema
public DirContext getSchema(Name name) throws NamingException
Retrieves the schema associated with the named object. The schema describes rules regarding the structure of the namespace and the attributes stored within it. The schema specifies what types of objects can be added to the directory and where they can be added; what mandatory and optional attributes an object can have. The range of support for schemas is directory-specific.- Specified by:
getSchema
in interfaceDirContext
- Parameters:
name
- the name of the object whose schema is to be retrieved- Returns:
- the schema associated with the context; never null
- Throws:
OperationNotSupportedException
- if schema not supportedNamingException
- if a naming exception is encountered
-
getSchema
public abstract DirContext getSchema(String name) throws NamingException
Retrieves the schema associated with the named object.- Specified by:
getSchema
in interfaceDirContext
- Parameters:
name
- the name of the object whose schema is to be retrieved- Returns:
- the schema associated with the context; never null
- Throws:
OperationNotSupportedException
- if schema not supportedNamingException
- if a naming exception is encountered
-
getSchemaClassDefinition
public DirContext getSchemaClassDefinition(Name name) throws NamingException
Retrieves a context containing the schema objects of the named object's class definitions.- Specified by:
getSchemaClassDefinition
in interfaceDirContext
- Parameters:
name
- the name of the object whose object class definition is to be retrieved- Returns:
- the DirContext containing the named object's class definitions; never null
- Throws:
OperationNotSupportedException
- if schema not supportedNamingException
- if a naming exception is encountered
-
getSchemaClassDefinition
public abstract DirContext getSchemaClassDefinition(String name) throws NamingException
Retrieves a context containing the schema objects of the named object's class definitions.- Specified by:
getSchemaClassDefinition
in interfaceDirContext
- Parameters:
name
- the name of the object whose object class definition is to be retrieved- Returns:
- the DirContext containing the named object's class definitions; never null
- Throws:
OperationNotSupportedException
- if schema not supportedNamingException
- if a naming exception is encountered
-
search
public NamingEnumeration<SearchResult> search(Name name, Attributes matchingAttributes, String[] attributesToReturn) throws NamingException
Searches in a single context for objects that contain a specified set of attributes, and retrieves selected attributes. The search is performed using the default SearchControls settings.- Specified by:
search
in interfaceDirContext
- Parameters:
name
- the name of the context to searchmatchingAttributes
- the attributes to search for. If empty or null, all objects in the target context are returned.attributesToReturn
- the attributes to return. null indicates that all attributes are to be returned; an empty array indicates that none are to be returned.- Returns:
- a non-null enumeration of SearchResult objects. Each SearchResult contains the attributes identified by attributesToReturn and the name of the corresponding object, named relative to the context named by name.
- Throws:
NamingException
- if a naming exception is encountered
-
search
public abstract NamingEnumeration<SearchResult> search(String name, Attributes matchingAttributes, String[] attributesToReturn) throws NamingException
Searches in a single context for objects that contain a specified set of attributes, and retrieves selected attributes.- Specified by:
search
in interfaceDirContext
- Parameters:
name
- the name of the context to searchmatchingAttributes
- the attributes to search for. If empty or null, all objects in the target context are returned.attributesToReturn
- the attributes to return. null indicates that all attributes are to be returned; an empty array indicates that none are to be returned.- Returns:
- a non-null enumeration of SearchResult objects. Each SearchResult contains the attributes identified by attributesToReturn and the name of the corresponding object, named relative to the context named by name.
- Throws:
NamingException
- if a naming exception is encountered
-
search
public NamingEnumeration<SearchResult> search(Name name, Attributes matchingAttributes) throws NamingException
Searches in a single context for objects that contain a specified set of attributes. This method returns all the attributes of such objects. It is equivalent to supplying null as the atributesToReturn parameter to the method search(Name, Attributes, String[]).- Specified by:
search
in interfaceDirContext
- Parameters:
name
- the name of the context to searchmatchingAttributes
- the attributes to search for. If empty or null, all objects in the target context are returned.- Returns:
- a non-null enumeration of SearchResult objects. Each SearchResult contains the attributes identified by attributesToReturn and the name of the corresponding object, named relative to the context named by name.
- Throws:
NamingException
- if a naming exception is encountered
-
search
public abstract NamingEnumeration<SearchResult> search(String name, Attributes matchingAttributes) throws NamingException
Searches in a single context for objects that contain a specified set of attributes.- Specified by:
search
in interfaceDirContext
- Parameters:
name
- the name of the context to searchmatchingAttributes
- the attributes to search for. If empty or null, all objects in the target context are returned.- Returns:
- a non-null enumeration of SearchResult objects. Each SearchResult contains the attributes identified by attributesToReturn and the name of the corresponding object, named relative to the context named by name.
- Throws:
NamingException
- if a naming exception is encountered
-
search
public NamingEnumeration<SearchResult> search(Name name, String filter, SearchControls cons) throws NamingException
Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls.- Specified by:
search
in interfaceDirContext
- Parameters:
name
- the name of the context or object to searchfilter
- the filter expression to use for the search; may not be nullcons
- the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())).- Returns:
- an enumeration of SearchResults of the objects that satisfy the filter; never null
- Throws:
InvalidSearchFilterException
- if the search filter specified is not supported or understood by the underlying directoryInvalidSearchControlsException
- if the search controls contain invalid settingsNamingException
- if a naming exception is encountered
-
search
public abstract NamingEnumeration<SearchResult> search(String name, String filter, SearchControls cons) throws NamingException
Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls.- Specified by:
search
in interfaceDirContext
- Parameters:
name
- the name of the context or object to searchfilter
- the filter expression to use for the search; may not be nullcons
- the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())).- Returns:
- an enumeration of SearchResults of the objects that satisfy the filter; never null
- Throws:
InvalidSearchFilterException
- if the search filter specified is not supported or understood by the underlying directoryInvalidSearchControlsException
- if the search controls contain invalid settingsNamingException
- if a naming exception is encountered
-
search
public NamingEnumeration<SearchResult> search(Name name, String filterExpr, Object[] filterArgs, SearchControls cons) throws NamingException
Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls.- Specified by:
search
in interfaceDirContext
- Parameters:
name
- the name of the context or object to searchfilterExpr
- the filter expression to use for the search. The expression may contain variables of the form "{i}" where i is a nonnegative integer. May not be null.filterArgs
- the array of arguments to substitute for the variables in filterExpr. The value of filterArgs[i] will replace each occurrence of "{i}". If null, equivalent to an empty array.cons
- the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())).- Returns:
- an enumeration of SearchResults of the objects that satisy the filter; never null
- Throws:
ArrayIndexOutOfBoundsException
- if filterExpr contains {i} expressions where i is outside the bounds of the array filterArgsInvalidSearchControlsException
- if cons contains invalid settingsInvalidSearchFilterException
- if filterExpr with filterArgs represents an invalid search filterNamingException
- if a naming exception is encountered
-
search
public abstract NamingEnumeration<SearchResult> search(String name, String filterExpr, Object[] filterArgs, SearchControls cons) throws NamingException
Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls.- Specified by:
search
in interfaceDirContext
- Parameters:
name
- the name of the context or object to searchfilterExpr
- the filter expression to use for the search. The expression may contain variables of the form "{i}" where i is a nonnegative integer. May not be null.filterArgs
- the array of arguments to substitute for the variables in filterExpr. The value of filterArgs[i] will replace each occurrence of "{i}". If null, equivalent to an empty array.cons
- the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())).- Returns:
- an enumeration of SearchResults of the objects that satisy the filter; never null
- Throws:
ArrayIndexOutOfBoundsException
- if filterExpr contains {i} expressions where i is outside the bounds of the array filterArgsInvalidSearchControlsException
- if cons contains invalid settingsInvalidSearchFilterException
- if filterExpr with filterArgs represents an invalid search filterNamingException
- if a naming exception is encountered
-
-