javax.naming.directory

接口
异常
java.lang.Object
  继承者 javax.naming.InitialContext
      继承者 javax.naming.directory.InitialDirContext
所有已实现的接口:
Context, DirContext
直接已知子类:
InitialLdapContext

public class InitialDirContext
     
extends InitialContext
implements DirContext

此类是执行目录操作的初始上下文。InitialContext 的类描述中的文档(包括关于同步的那些文档)在此处同样适用。

从以下版本开始:
1.3
另请参见:
InitialContext

字段摘要
 
从类 javax.naming.InitialContext 继承的字段
defaultInitCtx, gotDefault, myProps
 
从接口 javax.naming.directory.DirContext 继承的字段
ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE
 
从接口 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
 
构造方法摘要
  InitialDirContext()
          构造一个初始 DirContext。
protected InitialDirContext(boolean lazy)
          构造一个具有不进行初始化的选项的初始 DirContext。
  InitialDirContext(Hashtable<?,?> environment)
          使用所提供的环境构造一个初始 DirContext。
 
方法摘要
 void bind(Name name, Object obj, Attributes attrs)
          将名称与关联的属性一起绑定到一个对象。
 void bind(String name, Object obj, Attributes attrs)
          将名称与关联的属性一起绑定到一个对象。
 DirContext createSubcontext(Name name, Attributes attrs)
          创建并绑定新的上下文及关联的属性。
 DirContext createSubcontext(String name, Attributes attrs)
          创建并绑定新的上下文及关联的属性。
 Attributes getAttributes(Name name)
          检索与命名对象关联的所有属性。
 Attributes getAttributes(Name name, String[] attrIds)
          检索与命名对象关联的选定属性。
 Attributes getAttributes(String name)
          检索所有与命名对象关联的属性。
 Attributes getAttributes(String name, String[] attrIds)
          检索与命名对象关联的选定属性。
 DirContext getSchema(Name name)
          检索与命名对象关联的模式。
 DirContext getSchema(String name)
          检索与命名对象关联的模式。
 DirContext getSchemaClassDefinition(Name name)
          检索包含命名对象类定义的模式对象的上下文。
 DirContext getSchemaClassDefinition(String name)
          检索包含命名对象类定义的模式对象的上下文。
 void modifyAttributes(Name name, int mod_op, Attributes attrs)
          修改与命名对象关联的属性。
 void modifyAttributes(Name name, ModificationItem[] mods)
          使用有序的修改列表修改与命名对象关联的属性。
 void modifyAttributes(String name, int mod_op, Attributes attrs)
          修改与命名对象关联的属性。
 void modifyAttributes(String name, ModificationItem[] mods)
          使用有序的修改列表修改与命名对象关联的属性。
 void rebind(Name name, Object obj, Attributes attrs)
          将名称与关联的属性一起绑定到一个对象,并重写任何现有绑定。
 void rebind(String name, Object obj, Attributes attrs)
          将名称与关联的属性一起绑定到一个对象,并重写任何现有绑定。
 NamingEnumeration<SearchResult> search(Name name, Attributes matchingAttributes)
          在单个上下文中搜索包含指定属性集的对象。
 NamingEnumeration<SearchResult> search(Name name, Attributes matchingAttributes, String[] attributesToReturn)
          在单个上下文中搜索包含指定属性集的对象,并检索选定的属性。
 NamingEnumeration<SearchResult> search(Name name, String filterExpr, Object[] filterArgs, SearchControls cons)
          在命名上下文或对象中搜索符合给定搜索过滤器的项。
 NamingEnumeration<SearchResult> search(Name name, String filter, SearchControls cons)
          在命名上下文或对象中搜索符合给定搜索过滤器的项。
 NamingEnumeration<SearchResult> search(String name, Attributes matchingAttributes)
          在单个上下文中搜索包含指定属性集的对象。
 NamingEnumeration<SearchResult> search(String name, Attributes matchingAttributes, String[] attributesToReturn)
          在单个上下文中搜索包含指定属性集的对象,并检索选定的属性。
 NamingEnumeration<SearchResult> search(String name, String filterExpr, Object[] filterArgs, SearchControls cons)
          在命名上下文或对象中搜索符合给定搜索过滤器的项。
 NamingEnumeration<SearchResult> search(String name, String filter, SearchControls cons)
          在命名上下文或对象中搜索符合给定搜索过滤器的项。
 
从类 javax.naming.InitialContext 继承的方法
addToEnvironment, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, doLookup, doLookup, getDefaultInitCtx, getEnvironment, getNameInNamespace, getNameParser, getNameParser, getURLOrDefaultInitCtx, getURLOrDefaultInitCtx, init, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbind
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
从接口 javax.naming.Context 继承的方法
addToEnvironment, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, getEnvironment, getNameInNamespace, getNameParser, getNameParser, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbind
 

构造方法详细信息

InitialDirContext

protected InitialDirContext(boolean lazy)
                     throws NamingException
构造一个具有不进行初始化的选项的初始 DirContext。如果子类在调用 InitialDirContext 构造方法时仍然未知环境属性的值,则可以在其中使用此构造方法。子类的构造方法将调用此构造方法,计算环境的值,然后在返回之前调用 init()

参数:
lazy - 为 true 表示不初始化该初始 DirContext;为 false 等效于调用 new InitialDirContext()
抛出:
NamingException - 如果遇到命名异常
从以下版本开始:
1.3
另请参见:
InitialContext.init(Hashtable)

InitialDirContext

public InitialDirContext()
                  throws NamingException
构造一个初始 DirContext。不提供环境属性。等效于 new InitialDirContext(null)

抛出:
NamingException - 如果遇到命名异常
另请参见:
InitialDirContext(Hashtable)

InitialDirContext

public InitialDirContext(Hashtable<?,?> environment)
                  throws NamingException
使用所提供的环境构造一个初始 DirContext。环境属性已在 javax.naming.InitialContext 类描述中讨论。

此构造方法不会修改 environment 或保存一个对它的引用,但可能保存一个副本。

参数:
environment - 用于创建初始 DirContext 的环境。null 指示一个空环境。
抛出:
NamingException - 如果遇到命名异常
方法详细信息

getAttributes

public Attributes getAttributes(String name)
                         throws NamingException
从接口 DirContext 复制的描述
检索所有与命名对象关联的属性。有关详细信息,请参阅 DirContext.getAttributes(Name)

指定者:
接口 DirContext 中的 getAttributes
参数:
name - 对象名,通过该对象名检索属性
返回:
name 关联的属性集
抛出:
NamingException - 如果遇到命名异常

getAttributes

public Attributes getAttributes(String name,
                                String[] attrIds)
                         throws NamingException
从接口 DirContext 复制的描述
检索与命名对象关联的选定属性。有关详细信息,请参阅 DirContext.getAttributes(Name, String[])

指定者:
接口 DirContext 中的 getAttributes
参数:
name - 对象名,通过该对象名检索属性
attrIds - 要检索的属性的标识符。null 指示应该检索所有属性;空数组指示不应检索任何属性。
返回:
请求的属性;永远不为 null
抛出:
NamingException - 如果遇到命名异常

getAttributes

public Attributes getAttributes(Name name)
                         throws NamingException
从接口 DirContext 复制的描述
检索与命名对象关联的所有属性。请参阅关于属性模型、属性类型名称和操作属性的类描述。

指定者:
接口 DirContext 中的 getAttributes
参数:
name - 对象名,通过该对象名检索属性
返回:
name 关联的属性集。如果名称没有属性,则返回空属性集;永远不为 null。
抛出:
NamingException - 如果遇到命名异常
另请参见:
DirContext.getAttributes(String), DirContext.getAttributes(Name, String[])

getAttributes

public Attributes getAttributes(Name name,
                                String[] attrIds)
                         throws NamingException
从接口 DirContext 复制的描述
检索与命名对象关联的选定属性。请参阅关于属性模型、属性类型名称和操作属性的类描述。

如果对象没有指定的属性,则目录将忽略不存在的属性,并返回那些对象所具有的请求属性。

目录返回的属性可能多于请求(请参阅类描述中的属性类型名称),但不允许返回任意的、无关的属性。

另请参阅类描述中的操作属性

指定者:
接口 DirContext 中的 getAttributes
参数:
name - 对象名,通过该对象名检索属性
attrIds - 要检索的属性的标识符。null 指示应该检索所有属性;空数组指示不应检索任何属性。
返回:
请求的属性;永远不为 null
抛出:
NamingException - 如果遇到命名异常

modifyAttributes

public void modifyAttributes(String name,
                             int mod_op,
                             Attributes attrs)
                      throws NamingException
从接口 DirContext 复制的描述
修改与命名对象关联的属性。有关详细信息,请参阅 DirContext.modifyAttributes(Name, int, Attributes)

指定者:
接口 DirContext 中的 modifyAttributes
参数:
name - 属性将被更新的对象的名称
mod_op - 修改操作,为以下操作之一: ADD_ATTRIBUTEREPLACE_ATTRIBUTEREMOVE_ATTRIBUTE
attrs - 要用于修改的属性;不能为 null
抛出:
AttributeModificationException - 如果不能成功完成修改
NamingException - 如果遇到命名异常

modifyAttributes

public void modifyAttributes(Name name,
                             int mod_op,
                             Attributes attrs)
                      throws NamingException
从接口 DirContext 复制的描述
修改与命名对象关联的属性。没有指定修改的顺序。在可能的情况下,将以原子方式执行修改。

指定者:
接口 DirContext 中的 modifyAttributes
参数:
name - 属性将被更新的对象的名称
mod_op - 修改操作,为以下操作之一: ADD_ATTRIBUTEREPLACE_ATTRIBUTEREMOVE_ATTRIBUTE
attrs - 要用于修改的属性;不能为 null
抛出:
AttributeModificationException - 如果不能成功完成修改
NamingException - 如果遇到命名异常
另请参见:
DirContext.modifyAttributes(Name, ModificationItem[])

modifyAttributes

public void modifyAttributes(String name,
                             ModificationItem[] mods)
                      throws NamingException
从接口 DirContext 复制的描述
使用有序的修改列表修改与命名对象关联的属性。有关详细信息,请参阅 DirContext.modifyAttributes(Name, ModificationItem[])

指定者:
接口 DirContext 中的 modifyAttributes
参数:
name - 属性将被更新的对象的名称
mods - 要执行的修改的有序序列;不能为 null
抛出:
AttributeModificationException - 如果不能成功完成修改
NamingException - 如果遇到命名异常

modifyAttributes

public void modifyAttributes(Name name,
                             ModificationItem[] mods)
                      throws NamingException
从接口 DirContext 复制的描述
使用有序的修改列表修改与命名对象关联的属性。按指定的顺序执行修改。每个修改指定一个修改操作代码和一个对其执行操作的属性。在可能的情况下,将以原子方式执行修改。

指定者:
接口 DirContext 中的 modifyAttributes
参数:
name - 属性将被更新的对象的名称
mods - 要执行的修改的有序序列;不能为 null
抛出:
AttributeModificationException - 如果不能成功完成修改
NamingException - 如果遇到命名异常
另请参见:
DirContext.modifyAttributes(Name, int, Attributes), ModificationItem

bind

public void bind(String name,
                 Object obj,
                 Attributes attrs)
          throws NamingException
从接口 DirContext 复制的描述
将名称与关联的属性一起绑定到一个对象。有关详细信息,请参阅 DirContext.bind(Name, Object, Attributes)

指定者:
接口 DirContext 中的 bind
参数:
name - 要绑定的名称;不能为空
obj - 要绑定的对象;可能为 null
attrs - 要与绑定关联的属性
抛出:
NameAlreadyBoundException - 如果已经绑定了 name
InvalidAttributesException - 如果没有提供绑定的某些“强制”属性
NamingException - 如果遇到命名异常

bind

public void bind(Name name,
                 Object obj,
                 Attributes attrs)
          throws NamingException
从接口 DirContext 复制的描述
将名称与关联的属性一起绑定到一个对象。如果 attrs 为 null,则 objDirContext 时所得绑定将具有与 obj 关联的属性,否则不具有属性。如果 attrs 为非 null,则所得绑定的属性将为 attrs;所有与 obj 关联的属性都将被忽略。

指定者:
接口 DirContext 中的 bind
参数:
name - 要绑定的名称;不能为空
obj - 要绑定的对象;可能为 null
attrs - 要与绑定关联的属性
抛出:

JDK 1.6 中文手册