JNDI学习笔记(一) (转载)(www.chinaunix.net)

JNDI学习笔记(一)

作者:  发表于：2004-09-30 18:53:58

由于工作需要学习了一天的JNDI有一些收获,写下来与大家分享.高手可以帮忙纠正和指点,在此谢过!
 一:
  几个概念,Context,entry/object,filter.Attribute
  Context:上下文,我的理解是相当与文件系统的中的目录(JNDI的Naming Service是可以用操作系统的文件系统的,哈哈).
  entry/object:一个节点,相当与文件系统中的目录或文件.
  filter:查询/过滤条件是一个字符串表达式如:(&(objectClass=top)(cn=*))查询出objectClass属性为top,cn属性为所有情况的entry.
  Attribute:entry/object的属性可以理解成JAVA对象的属性,不同的是这个属性可以多次赋值.

JNDI学习笔记(一)

作者:  发表于：2004-09-30 18:53:58

由于工作需要学习了一天的JNDI有一些收获,写下来与大家分享.高手可以帮忙纠正和指点,在此谢过!
 一:
  几个概念,Context,entry/object,filter.Attribute
  Context:上下文,我的理解是相当与文件系统的中的目录(JNDI的Naming Service是可以用操作系统的文件系统的,哈哈).
  entry/object:一个节点,相当与文件系统中的目录或文件.
  filter:查询/过滤条件是一个字符串表达式如:(&(objectClass=top)(cn=*))查询出objectClass属性为top,cn属性为所有情况的entry.
  Attribute:entry/object的属性可以理解成JAVA对象的属性,不同的是这个属性可以多次赋值.

二:
  Naming Service的简单例子,JNDI的全称是名字与目录服务,LDAP服务器都可以做Naming Service和Directory Service.JNDI Toturial上为了方面用File System做为naming service.以下的一个例子是演示一个从File System Lookup.
[code:1:8cd9b64f92]
package study.jndi;

import java.util.Hashtable;
import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;

public class Lookup{
public static void main(String[] args){
Hashtable env = new Hashtable();
String name = "C:/aaa.txt";
try{
env.put(Context.INITIAL_CONTEXT_FACTORY,"com.sun.jndi.fscontext.RefFSContextFactory"); //use the file system as service provider
Context ctx = new InitialContext(env);
Object obj = ctx.lookup(name);
System.out.println("the name " + name + " is bound to object:" + obj);
}catch(Exception ex){
ex.printStackTrace();
}


}
}
[/code:1:8cd9b64f92]
为了运行的程序你要到[url][/url]下载JNDI的相关包,然后把两个jar:fscontext.jar和providerutil.jar加入到你的CLASSPATH中.这样就可以运行了.你可以做进一步的操纵如bind,unbind等等.
Context ctx = new InitialContext();是以文件系统为初始上下文,这样一来你可以把String name = "C:/aaa.txt";换成你系统中的任意目录和文件的路径名.
env.put(Context.INITIAL_CONTEXT_FACTORY,"com.sun.jndi.fscontext.RefFSContextFactory");是指明Service provider是文件系统.

由于我的工作主要是对Directory Service进行操作,所以重点学习了,javax.naming.directory包中的类.以下的几个例子演示从LDAP上查询ENTRY并得到属性和属性值.
假设我的LDAP是这样存放的:  根节点c=com 二级节点 ou=t 以及其它 三级节点 ou = xc 以及其它 四级节点 cn=bsj. LDAP服务器安装在我自己的机器上。
下面的一个例子是找到一个entry(object/节点,一个意思).然后取出所有的属性值。
[code:1:e63e699738]
package study.jndi;

import java.util.Hashtable;
import javax.naming.Context;
import javax.naming.NamingException;
import javax.naming.NamingEnumeration;
import javax.naming.directory.DirContext;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
import javax.naming.directory.InitialDirContext;


public class GetAttr{
public static final String ENTRY_NAME = "cn=bsj,ou=xc,ou=t,c=com";
public static void main(String[] args){

Hashtable env = new Hashtable();
env.put(Context.INITIAL_CONTEXT_FACTORY,"com.sun.jndi.ldap.LdapCtxFactory");
env.put(Context.PROVIDER_URL,"ldap://127.0.0.1:10389/"); //login the ldap server
try{
DirContext ctx = new InitialDirContext(env);
Attributes allAttr = ctx.getAttributes(ENTRY_NAME); //get *a* object's all attributes
for(NamingEnumeration attrs = allAttr.getAll();attrs.hasMore();){
Attribute attr = (Attribute)attrs.next();
System.out.println("Attribute is : " + attr.getID());
for(NamingEnumeration values = attr.getAll();values.hasMore();){
System.out.println("    value is : " + values.next());
}
}

}catch(NamingException ex){
ex.printStackTrace();
}
System.out.println("SUCCESS!");
}
}
[/code:1:e63e699738]
这个例子需要到同样的地址下载ldap.jar然后加入到CLASSPATH中，就可以执行，当然要保证你有一个配置到的LDAP服务器，我的是公司专用的服务器并且是配置好的，所以你要去找一个LDAP服务器安装好在运行这个例子。这个例子的原理就是用ctx根据节点的DN(专有名词，可以看做是文件名)来查找这个entry的所有属性，然后在从属性中得到所有的值，注意一个属性可以有多个值，如果你熟悉LDAP就会知道了。
下边这个例子在以上的例子基础上加了一个设置entry返回的属性都有哪些。
[code:1:e63e699738]
package study.jndi;

import java.util.Hashtable;
import javax.naming.Context;
import javax.naming.NamingException;
import javax.naming.NamingEnumeration;
import javax.naming.directory.DirContext;
import javax.naming.directory.InitialDirContext;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
public class GetAttr2{
public static final String ENTRY_NAME = "cn=bsj,ou=xc,ou=t,c=com";
public static void main(String[] args){
Hashtable env = new Hashtable();
env.put(Context.INITIAL_CONTEXT_FACTORY,"com.sun.jndi.ldap.LdapCtxFactory");
env.put(Context.PROVIDER_URL,"ldap://127.0.0.1:10389/"); //login the ldap server
String[] attrNames = new String[]{"abc"};  //get a attribute's value
try{
DirContext ctx = new InitialDirContext(env);
Attributes attrs = ctx.getAttributes(ENTRY_NAME,attrNames);
for(NamingEnumeration ae = attrs.getAll();ae.hasMore();){
Attribute attr = (Attribute)ae.next();
System.out.println("Attribute : " + attr.getID());
for(NamingEnumeration ve = attr.getAll();ve.hasMore();){
System.out.println("  Value : " + ve.next());
}
}
}catch(NamingException ex){
ex.printStackTrace();
}
System.out.println("SUCCESS!");
}
}
[/code:1:e63e699738]
下面的例子是利用DirContext提供的search方法对entry进行查找。
这个是查找一个CONTEXT下符合条件的一个或多个节点。
[code:1:bdd3134024]
package study.jndi;

import java.util.Hashtable;
import javax.naming.Context;
import javax.naming.NamingException;
import javax.naming.NamingEnumeration;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
import javax.naming.directory.BasicAttribute;
import javax.naming.directory.BasicAttributes;
import javax.naming.directory.DirContext;
import javax.naming.directory.InitialDirContext;
import javax.naming.directory.SearchResult;


public class BasicSearch{
public static final String ROOT_ENTRY = "ou=xc,ou=t,c=com";
public static void main(String[] args){
Hashtable env = new Hashtable();
env.put(Context.INITIAL_CONTEXT_FACTORY,"com.sun.jndi.ldap.LdapCtxFactory");
env.put(Context.PROVIDER_URL,"ldap://127.0.0.1:10389/");
try{
DirContext ctx = new InitialDirContext(env);
Attributes matchAttrs = new BasicAttributes(true);//the attributes is interface
matchAttrs.put(new BasicAttribute("cn","txc"));
matchAttrs.put(new BasicAttribute("objectClass","top"));
NamingEnumeration se = ctx.search(ROOT_ENTRY,matchAttrs);
while(se.hasMore()){
SearchResult searchResult = (SearchResult)se.next();
System.out.println("**SearchResult : " + searchResult.getName());
JNDITools.listAttributes(searchResult.getAttributes());
}
}catch(NamingException ex){
ex.printStackTrace();
}
System.out.println("SUCCESS!");
}
}[/code:1:bdd3134024]
下面这个例子是应该是最常用的查询操作的例子用到了DirContext的几个search方法中的一个。
[code:1:4677901149]
package study.jndi;

import java.util.Hashtable;
import javax.naming.Context;
import javax.naming.NamingException;
import javax.naming.NamingEnumeration;
import javax.naming.directory.DirContext;
import javax.naming.directory.InitialDirContext;
import javax.naming.directory.SearchResult;
import javax.naming.directory.SearchControls;

public class FilterSearch{
        public static final String ROOT_ENTRY = "ou=xc,ou=t,c=com";
        public static void main(String[] args){
Hashtable env = new Hashtable();
env.put(Context.INITIAL_CONTEXT_FACTORY,"com.sun.jndi.ldap.LdapCtxFactory");    
env.put(Context.PROVIDER_URL,"ldap://127.0.0.1:10389/");                                    
try{
DirContext ctx = new InitialDirContext(env);
SearchControls controls = new SearchControls();
String filter = "(&(objectClass=top)(cn=*))";

/**
 * OBJECT_SCOPE
 *controls.setSearchScope(SearchControls.OBJECT_SCOPE);
 *NamingEnumeration se = ctx.search("cn=txc,ou=xc,ou=t,c=com",filter,controls);
*/
controls.setCountLimit(100); //If the program attempts to get more than the count limit number of results, then a SizeLimitExceededException will be thrown 
controls.setSearchScope(SearchControls.SUBTREE_SCOPE);
NamingEnumeration se = ctx.search("c=com",filter,controls);
while(se.hasMore()){
SearchResult result = (SearchResult)se.next();
System.out.println("**SearchResult : " + result.getName());
JNDITools.listAttributes(result.getAttributes());
}
}catch(NamingException ex){
ex.printStackTrace();
}
                System.out.println("SUCCESS!");
        }
}
[/code:1:4677901149]
下面对以上的代码进行解释：search()方法的第一个参数是一个上下文执行时在这个上下文下进行查找，第二个参数是一个Filter字串意思是符合objectClass=top并且cn属性为任意值的entry，第三个属性是一个SearchControls对象在这个对象中设置一些参数用于控制查找，如controls.setSearchScope(SearchControls.SUBTREE_SCOPE);这个方法中有三个值，SUBTREE_SCOPE为查找给定上下文(第一个参数)下以及所有下级上下文下的所有entry,而ONELEVEL_SCOPE只查找给定上下文下的entry，OBJECT_SCOPE只查找一个entry。controls.setCountLimit(100); 是设置查找返回的最大结果，如果查询的结果超过了这个值那么就会抛出一个异常。还有一个设置超时时间的方法setTimeout()。
对了还有一个工具类用于打印给定属性集合中的所有属性以及属性的值代码如下：
[code:1:4677901149]
package study.jndi;

import javax.naming.NamingException;
import javax.naming.NamingEnumeration;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
public class JNDITools{
public static void listAttributes(Attributes attrs)throws NamingException{
for(NamingEnumeration ae = attrs.getAll();ae.hasMore();){
Attribute attr = (Attribute)ae.next();
System.out.println("Attribute : " + attr.getID());
for(NamingEnumeration ve = attr.getAll();ve.hasMore();){
System.out.println("  value : " + ve.next());
}
}
}
}[/code:1:4677901149]

在这里抛砖引玉，希望熟悉JNDI的朋友会给出好的建议，哈哈，更希望给和我一样的初学者提供帮助。先写到这里。
参考资料：JNDI Toturial [url][/url]