詳解JNDI的lookup資源引用java:/comp/env
ENC的概念:
The application component environment is referred to as the ENC, the enterprise naming context.
應用元件的業務邏輯應該是 ENC中取得物件。元件提供者使用標準的部署描述符指定必需的ENC入口。這些ENC入口是執行時元件所依賴的資源等資訊。
一個應用元件例項使用 JNDI定位ENC。ENC的標準JNDI CONTEXT是:java;/comp/env
// Obtain the application component's ENC Context iniCtx = new InitialContext(); Context compEnv = (Context) iniCtx.lookup("java:comp/env");
env環 境是一個私有的環境,只能在該元件內部存取。對其它元件是不可見的。比如,EJB1不能存取EJB2的ENV。同樣,任何一個客戶端程式碼,不管它是執行在 應用伺服器的同一個JVM內或者是遠端呼叫,均不能訪問這些JNDI。這樣的話,元件之間是相互隔離的,不同元件之間可以定義它自己的環境引數。比如 EJB1可以定義自己的環境變數引數:java:comp/env/red
1、JBOSS的名稱空間:
比如一個命名: java:comp/env 凡是繫結在java: 名字下面的子環境,均只能在JBOSS 伺服器內部才能進行訪問。無法進行遠端訪問,比如DataSource 均被繫結在 java:下面。不能遠端訪問。而EJB,JTA均被繫結在全域性範圍之內,能進行遠端訪問。
一些慣用的ENV:
ENV 用env-entry 進行申明。
ejb引用用 ejb-ref,ejb-local-ref 進行申明。
資源管理連線工廠用resource-ref 進行申明。
資源環境變數引用用resource-env-ref進行申明。
1.1 Environment Entries
例子:
<session> <ejb-name>ASessionBean</ejb-name> <!-- ... --> <env-entry> <description>The maximum number of tax exemptions allowed </description> <env-entry-name>maxExemptions</env-entry-name> <env-entry-type>java.lang.Integer</env-entry-type> <env-entry-value>15</env-entry-value> </env-entry> <env-entry> <description>The tax rate </description> <env-entry-name>taxRate</env-entry-name> <env-entry-type>java.lang.Float</env-entry-type> <env-entry-value>0.23</env-entry-value> </env-entry> </session>
ENC env-entry access code fragment
InitialContext iniCtx = new InitialContext();
Context envCtx = (Context) iniCtx.lookup("java:comp/env");
Integer maxExemptions = (Integer) envCtx.lookup("maxExemptions");
Float taxRate = (Float) envCtx.lookup("taxRate");
1.2 EJB Reference
在開發過程,有時候需在 EJB之間進行相互引用。這個引用一般均要根據JNDI名字才能進行,但JNDI名字是在部署時才能決定。因此需要一種手段,引用在部署時的另一個 EJB,ejb-reference就是為了滿足這種要求。
ejb reference 是一個在應用元件命名環境下指向一個部署時EJB HOME的連結。J2EE規範推薦所有的此種連結應接被組織在java:/comp/env/ejb名稱空間下。
<session> <ejb-name>ShoppingCartBean</ejb-name> <!-- ...--> </session>
<session> <ejb-name>ProductBeanUser</ejb-name> <!--...--> <ejb-ref> <description>This is a reference to the store products entity </description> 此屬性可選 <ejb-ref-name>ejb/ProductHome</ejb-ref-name> <ejb-ref-type>Entity</ejb-ref-type> 只能選Entity與Session <home>org.jboss.store.ejb.ProductHome</home> </ejb-ref> <remote> org.jboss.store.ejb.Product</remote> </session>
<session> <ejb-name>ShoppingCartUser</ejb-name> <!--...-->
<ejb-ref> <ejb-ref-name>ejb/ShoppingCartHome</ejb-ref-name> <ejb-ref-type>Session</ejb-ref-type> <home>org.jboss.store.ejb.ShoppingCartHome</home> <remote> org.jboss.store.ejb.ShoppingCart</remote> <ejb-link>ShoppingCartBean</ejb-link>
指向同一個EJB JAR 或 同一個 APPLICATION UNIT中的一個EJB,且是該 EJB的名字。 </ejb-ref> </session>
<entity> <description>The Product entity bean </description> <ejb-name>ProductBean</ejb-name> <!--...--> </entity>
ejb-ref的範圍是屬於申明此段屬性的EJB元件。這就意味著其它的應用元件在執行時不能訪問這些屬性。其它元件定義相同的名字也不會引用名稱衝突。
InitialContext iniCtx = new InitialContext(); Context ejbCtx = (Context) iniCtx.lookup("java:comp/env/ejb"); ShoppingCartHome home = (ShoppingCartHome) ejbCtx.lookup("ShoppingCartHome");
JBOSS的引用方法:
<session> <ejb-name>ProductBeanUser</ejb-name> <ejb-ref> <ejb-ref-name>ejb/ProductHome</ejb-ref-name> 對應於ejb-jar.xml檔案中的ejb-ref-name元素 <jndi-name>jboss/store/ProductHome</jndi-name> </ejb-ref> </session>
<entity> <ejb-name>ProductBean</ejb-name> <jndi-name>jboss/store/ProductHome</jndi-name> <!-- ... --> </entity>
從上面可以看出,如果ejb/ProductHome的引用被重新定向給了jndi-name : jboss/store/ProductHome
1.3 EJB Local Reference
EJB 2.0 增加了 ejb local reference , 從而從語義學的角度保證該引用為本地引用,而不是通過RMI的方式。
<session> <ejb-name>Probe</ejb-name> <home>org.jboss.test.perf.interfaces.ProbeHome</home> <remote>org.jboss.test.perf.interfaces.Probe</remote> <local-home>org.jboss.test.perf.interfaces.ProbeLocalHome</local-home> <local>org.jboss.test.perf.interfaces.ProbeLocal</local> <ejb-class>org.jboss.test.perf.ejb.ProbeBean</ejb-class> <session-type>Stateless</session-type> <transaction-type>Bean</transaction-type> </session> <session> <ejb-name>PerfTestSession</ejb-name> <home>org.jboss.test.perf.interfaces.PerfTestSessionHome</home> <remote>org.jboss.test.perf.interfaces.PerfTestSession</remote> <ejb-class>org.jboss.test.perf.ejb.PerfTestSessionBean</ejb-class> <session-type>Stateless</session-type> <transaction-type>Container</transaction-type> <ejb-ref> <ejb-ref-name>ejb/ProbeHome</ejb-ref-name> <ejb-ref-type>Session</ejb-ref-type> <home>org.jboss.test.perf.interfaces.SessionHome</home> <remote>org.jboss.test.perf.interfaces.Session</remote> <ejb-link>Probe</ejb-link> </ejb-ref> <ejb-local-ref> <ejb-ref-name>ejb/ProbeLocalHome</ejb-ref-name> <ejb-ref-type>Session</ejb-ref-type> <local-home>org.jboss.test.perf.interfaces.ProbeLocalHome</local-home> <local>org.jboss.test.perf.interfaces.ProbeLocal</local>
EJB local interface 的全限定名 <ejb-link>Probe</ejb-link> </ejb-local-ref> </session>
存取的語法:
InitialContext iniCtx = new InitialContext(); Context ejbCtx = (Context) iniCtx.lookup("java:comp/env/ejb"); ProbeLocalHome home = (ProbeLocalHome) ejbCtx.lookup("ProbeLocalHome");
1.4 Resource manaager connection factory reference
由一系列的 resource-ref 組成。每個引用以下幾個子節點:
description (optional)
res-ref-name : java:/comp/env 下面的相關的名字
res-type : 資源的型別,資源管理器連線工廠的全限定名稱。
res-auth : 資源需要的許可權管理。 分兩種:Application 或 container
res-share-scope (optional) : 目前JBOSS 不支援。
J2EE規範推薦所有資源引用都組織在java:/comp/env 名稱空間之下,並且每類資源有自己的子名稱空間。
比如:JDBC DataSource Reference should be declared in the java:/comp/env/jdbc subContext.
JMS connection factories should be declared int the java:/comp/env/jms subContext.
一個在WEB.XML檔案中的引用例子:
<web> <!-- ... --> <servlet> <servlet-name>AServlet</servlet-name> <!-- ... --> </servlet> <!-- ... --> <!-- JDBC DataSources (java:comp/env/jdbc) --> <resource-ref> <description>The default DS</description> <res-ref-name>jdbc/DefaultDS</res-ref-name> 該名稱必須與下面的描述檔案中的一致 <res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth> </resource-ref> <!-- JavaMail Connection Factories (java:comp/env/mail) --> <resource-ref> <description>Default Mail</description> <res-ref-name>mail/DefaultMail</res-ref-name> <res-type>javax.mail.Session</res-type> <res-auth>Container</res-auth> </resource-ref> <!-- JMS Connection Factories (java:comp/env/jms) --> <resource-ref> <description>Default QueueFactory</description> <res-ref-name>jms/QueueFactory</res-ref-name> <res-type>javax.jms.QueueConnectionFactory</res-type> <res-auth>Container</res-auth> </resource-re>
程式中進行引用:
Context initCtx = new InitialContext(); javax.mail.Session s = (javax.mail.Session) initCtx.lookup("java:comp/env/mail/DefaultMail");
jboss-web.xml(對應於WEB),jboss.xml(對應於ejb) 檔案提供res-ref-name對JNDI名字的轉換。
這是通過在 jboss.xml 或 jboss-web.xml 檔案中提供 resource-ref 完成的。
比如:
<jboss-web> <!-- ... --> <resource-ref> <res-ref-name>jdbc/DefaultDS</res-ref-name> <res-type>javax.sql.DataSource</res-type> <jndi-name>java:/DefaultDS</jndi-name> 將資源引用重定向到JNDI上面 </resource-ref> <resource-ref> <res-ref-name>mail/DefaultMail</res-ref-name> <res-type>javax.mail.Session</res-type> <jndi-name>java:/Mail</jndi-name> </resource-ref> <resource-ref> <res-ref-name>jms/QueueFactory</res-ref-name> <res-type>javax.jms.QueueConnectionFactory</res-type> <jndi-name>QueueConnectionFactory</jndi-name> </resource-ref> <!-- ... --> </jboss-web>
Resource Environment References 提供了 resource 本身需要使用的資源。
<session> <ejb-name>MyBean</ejb-name> <resource-env-ref> <description>This is a reference to a JMS queue used in the processing of Stock info </description> <resource-env-ref-name>jms/StockInfo</resource-env-ref-name> <resource-env-ref-type>javax.jms.Queue</resource-env-ref-type> </resource-env-ref> <!-- ... --> </session>
在程式中訪問:
InitialContext iniCtx = new InitialContext(); javax.jms.Queue q = (javax.jms.Queue) envCtx.lookup("java:comp/env/jms/StockInfo");
同樣道理,特定平臺仍需提供 resource-env-ref-name 至 JNDI 的轉換,比如在JBOSS.xml檔案中:
<session> <ejb-name>MyBean</ejb-name> <resource-env-ref> <resource-env-ref-name>jms/StockInfo </resource-env-ref-name> <jndi-name>queue/StockInfoQueue</jndi-name> 此為真正的全域性JNDI名字 </resource-env-ref> <!-- ... --> </session>