詳解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>