Resource injection for env entry in the field

[Siva Masilamani]

Hi

I have a doubt about injecting the env entry into EJB3.

In EJB 2.1

ejb-jar.xml :

 <env-entry>
                <env-entry-name>envEntry</env-entry-name>
                <env-entry-type>java.lang.Integer</env-entry-type>
                <env-entry-value>100</env-entry-value>
            </env-entry>  

Then in the code :

InitialContext ic=new InitialContext();
Object o=ic.lookup("java:comp/env//envEntry");
int value=(Integer)o;
 

But in EJB 3 we do not need ejb-jar.xml so that we could use annotation to inject the env entry in the code itself,so we can write the code as follows in one of the beans :

  @Resource int envEntry=100;  

Please let me know that both of these are equivalent?

Also i was going through the specification and came to know that by default the env declared as above will be mapped as package.className/fieldName in the bean's jndi name. But when i try to access the field with that name i am getting NameNotFoundException.

Please hele me to correct the problem why the environment entry is not found?

I also tried to use name in the resource annotation and then in the business method tried to look up with java:comp/env/nameGivenInAnnoatation but again getting the same error.

Or is it mandantory that i should provide ejb-jar.xml file when i use JNDI api ?

I am using Glassfish V3 app server.

Complete bean code i was trying:

  package com.scbcd.ejbs;

import javax.annotation.*;
import javax.ejb.*;
import javax.naming.*;

/**
 *
 * @author Siva
 */
@Stateful
public class StatefulBeanExample implements StatefulBeanRemote{

    @Resource SessionContext context;

    @Resource int envEntry=99;

    public String businessMethod() {
        try{
        System.out.println(context.getInvokedBusinessInterface().getName());
        InitialContext ic=new InitialContext();
        Object o=ic.lookup("java:comp/env/com.scbcd.ejbs.StatefulBeanExample/envEntry");
        int value=(Integer)o;
        System.out.println("Business method "+value);
        }catch(Exception e){
            e.printStackTrace();
        }
        return "businessMethod returned";
    }

    @PostConstruct
    public void init(){        
        System.out.println("postConstruct called");
        System.out.println("Env entry value is "+envEntry);      
    }

    @PreDestroy
    public void destroy(){
        System.out.println("preDestroy called");
    }

    @PrePassivate
    public void passivate(){
        System.out.println("Before passivation");
    }

    @PostActivate
    public void activate(){
        System.out.println("After activation");
    }
 
}  

[Jaikiran Pai]

Which application server and which version of it are you using? Also please post the entire exception stacktrace.

[Siva Masilamani]

I have already mentioned the application server:

Glassfish V3

The exception stack trace:

 INFO: ACDEPL103: Java Web Start services started for the app client SCBCDEE/SCBCD5Client.jar (contextRoot: /SCBCDEE/SCBCD5Client)
INFO: SCBCDEE was successfully deployed in 4,203 milliseconds.
INFO: postConstruct called
INFO: Env entry value is 99
INFO: com.scbcd.ejbs.StatefulBeanRemote
SEVERE: javax.naming.NamingException: Lookup failed for 'java:comp/env/com.scbcd.ejbs.StatefulBeanExample/envEntry' in SerialContext  [Root exception is javax.naming.NameNotFoundException: No object bound to name java:comp/env/com.scbcd.ejbs.StatefulBeanExample/envEntry]
        at com.sun.enterprise.naming.impl.SerialContext.lookup(SerialContext.java:442)
        at javax.naming.InitialContext.lookup(InitialContext.java:392)
        at javax.naming.InitialContext.lookup(InitialContext.java:392)
        at com.scbcd.ejbs.StatefulBeanExample.businessMethod(StatefulBeanExample.java:27)
        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
        at java.lang.reflect.Method.invoke(Method.java:597)
        at org.glassfish.ejb.security.application.EJBSecurityManager.runMethod(EJBSecurityManager.java:1052)
        at org.glassfish.ejb.security.application.EJBSecurityManager.invoke(EJBSecurityManager.java:1124)
        at com.sun.ejb.containers.BaseContainer.invokeTargetBeanMethod(BaseContainer.java:4038)
        at com.sun.ejb.containers.BaseContainer.__intercept(BaseContainer.java:5223)
        at com.sun.ejb.containers.BaseContainer.intercept(BaseContainer.java:5203)
        at com.sun.ejb.containers.EJBObjectInvocationHandler.invoke(EJBObjectInvocationHandler.java:201)
        at com.sun.ejb.containers.EJBObjectInvocationHandlerDelegate.invoke(EJBObjectInvocationHandlerDelegate.java:75)
        at $Proxy135.businessMethod(Unknown Source)
        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
        at java.lang.reflect.Method.invoke(Method.java:597)
        at com.sun.corba.ee.impl.presentation.rmi.ReflectiveTie.dispatchToMethod(ReflectiveTie.java:146)
        at com.sun.corba.ee.impl.presentation.rmi.ReflectiveTie._invoke(ReflectiveTie.java:176)
        at com.sun.corba.ee.impl.protocol.CorbaServerRequestDispatcherImpl.dispatchToServant(CorbaServerRequestDispatcherImpl.java:682)
        at com.sun.corba.ee.impl.protocol.CorbaServerRequestDispatcherImpl.dispatch(CorbaServerRequestDispatcherImpl.java:216)
        at com.sun.corba.ee.impl.protocol.CorbaMessageMediatorImpl.handleRequestRequest(CorbaMessageMediatorImpl.java:1841)
        at com.sun.corba.ee.impl.protocol.CorbaMessageMediatorImpl.handleRequest(CorbaMessageMediatorImpl.java:1695)
        at com.sun.corba.ee.impl.protocol.CorbaMessageMediatorImpl.handleInput(CorbaMessageMediatorImpl.java:1078)
        at com.sun.corba.ee.impl.protocol.giopmsgheaders.RequestMessage_1_2.callback(RequestMessage_1_2.java:221)
        at com.sun.corba.ee.impl.protocol.CorbaMessageMediatorImpl.handleRequest(CorbaMessageMediatorImpl.java:797)
        at com.sun.corba.ee.impl.protocol.CorbaMessageMediatorImpl.dispatch(CorbaMessageMediatorImpl.java:561)
        at com.sun.corba.ee.impl.protocol.CorbaMessageMediatorImpl.doWork(CorbaMessageMediatorImpl.java:2558)
        at com.sun.corba.ee.impl.orbutil.threadpool.ThreadPoolImpl$WorkerThread.performWork(ThreadPoolImpl.java:492)
        at com.sun.corba.ee.impl.orbutil.threadpool.ThreadPoolImpl$WorkerThread.run(ThreadPoolImpl.java:528)
Caused by: javax.naming.NameNotFoundException: No object bound to name java:comp/env/com.scbcd.ejbs.StatefulBeanExample/envEntry
        at com.sun.enterprise.naming.impl.GlassfishNamingManagerImpl.lookup(GlassfishNamingManagerImpl.java:684)
        at com.sun.enterprise.naming.impl.GlassfishNamingManagerImpl.lookup(GlassfishNamingManagerImpl.java:657)
        at com.sun.enterprise.naming.impl.JavaURLContext.lookup(JavaURLContext.java:148)
        at com.sun.enterprise.naming.impl.SerialContext.lookup(SerialContext.java:428)
        ... 32 more

   

Client code:

  import com.scbcd.ejbs.*;
import javax.ejb.*;
public class Client {

    /**
     * @param args the command line arguments
     */

    @EJB
    static StatefulBeanRemote client;
    public static void main(String[] args) {
        // TODO code application logic here
        client.businessMethod();
    }

}  

I bundled them as ear file and ran the client.I am using Netbeans 6.8 IDE.

[Siva Masilamani]

Can you help me now?

[Deena Jeyachandran]

Your resource type is declared as int primitive. Could you try Integer type?

[Deena Jeyachandran]

Please disregard my last post. Thats incorrect.

[Deena Jeyachandran]

When you define @Resource, you are declaring the resource reference to use directly in you class. So I think you don't there is need for jndi lookup. You can use it as a instance variable directly.

If I am correct, I have a question.
If you are declaring the value of variable directly in the class, why do you want to use Resource annotation. It could be a simple instance variable.

[Mihai Radulescu]

@Siva : did you place the env-entry node in the right place ? It must be placed in the node corresponding your bean. Also it must follow the ENC rules package + class / field.

[Mihai Radulescu]

@Siva : please consider also this example :

Context ictx = new InitialContext();
Context env = (Context)initCtx.lookup("java:comp/env");
Integer yourInt = (Integer) env.lookup("yourKey");

[Siva Masilamani]

@Siva : did you place the env-entry node in the right place ? It must be placed in the node corresponding your bean. Also it must follow the ENC rules package + class / field.

I did not create DD at all.

i was going through the specification and came to know about the default naming convention used by the container when Resource or EJB annotation is used.

So as per the specification this "envEntry" should be named as 'java:comp/env/com.scbcd.ejbs.StatefulBeanExample/envEntry'

But when i look up using this name,i am getting NameNotFoundException.

But if i use DD and override the value then i am getting the output from both of PostConstructor and Business method with overriden value but if i remove DD then only PostConstructor works.

With the below DD i am gettin 100 at both the methods but without this, business method failed:

  <?xml version="1.0" encoding="UTF-8"?>

<ejb-jar xmlns = "http://java.sun.com/xml/ns/javaee" 
         version = "3.0" 
         xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" 
         xsi:schemaLocation = "http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/ejb-jar_3_0.xsd">
             <enterprise-beans>
                 <session>
                     <ejb-name>ReadEnvEntryEJB</ejb-name>
                     <ejb-class>com.scbcd.ejbs.StatefulBeanExample</ejb-class>
                     <business-remote>com.scbcd.ejbs.StatefulBeanRemote</business-remote>
                     <env-entry>
                         <env-entry-name>com.scbcd.ejbs.StatefulBeanExample/envEntry</env-entry-name>
                         <env-entry-type>java.lang.Integer</env-entry-type>
                         <env-entry-value>100</env-entry-value>
                     </env-entry>
                 </session>
             </enterprise-beans>
</ejb-jar>  

If I am correct, I have a question.
If you are declaring the value of variable directly in the class, why do you want to use Resource annotation. It could be a simple instance variable.

I know that it is of no use to declare Resource annotation at env-entry with the value specified at the EJB class,but i created to test that the the value at the DD overrides this or not.

Thanks.

[Jaikiran Pai]

Looking at your JNDI lookup code, I would have expected it to pass. However, I am confused about your Client code. What is it? An application client? Because I see that you are injecting the bean in that Client (which looks like some standalone piece of code).

[Siva Masilamani]

No it is Application Client.

I am using Netbeans IDE where i have created EJB and AppClient Project and bundled them into EAR and deployed the EAR into Glassfish v3.

@Siva : please consider also this example

It doesn't work either.


I tried the below code and the output was:

public String businessMethod() {
        try{
        //System.out.println(context.getInvokedBusinessInterface().getName());
        InitialContext ic=new InitialContext();
        Object o=context.lookup("com.scbcd.ejbs.StatefulBeanExample/envEntry");
        int value=(Integer)o;
        System.out.println("Business method "+value);
        NamingEnumeration enm=ic.list("java:comp/env/");
        while(enm.hasMoreElements()){
            System.out.println(enm.next());
        }
        //System.out.println("JNDI Entries :"+ic.list("java:comp/env/"));
        }catch(Exception e){
            e.printStackTrace();
        }
        return "businessMethod returned";
    }

Output :

INFO: ACDEPL104: Java Web Start services stopped for the app client SCBCDEAR5/SCBCDEAR5-app-client.jar
INFO: Portable JNDI names for EJB StatefulBeanExample : [java:global/SCBCDEAR5/SCBCDEJB5/StatefulBeanExample!com.scbcd.ejbs.StatefulBeanRemote, java:global/SCBCDEAR5/SCBCDEJB5/StatefulBeanExample!com.scbcd.ejbs.StatefulBeanExample]
INFO: Glassfish-specific (Non-portable) JNDI names for EJB StatefulBeanExample : [com.scbcd.ejbs.StatefulBeanRemote#com.scbcd.ejbs.StatefulBeanRemote, com.scbcd.ejbs.StatefulBeanRemote]
INFO: ACDEPL103: Java Web Start services started for the app client SCBCDEAR5/SCBCDEAR5-app-client.jar (contextRoot: /SCBCDEAR5/SCBCDEAR5-app-client)
INFO: SCBCDEAR5 was successfully deployed in 1,062 milliseconds.
INFO: ACDEPL104: Java Web Start services stopped for the app client SCBCDEAR5/SCBCDEAR5-app-client.jar
INFO: Portable JNDI names for EJB StatefulBeanExample : [java:global/SCBCDEAR5/SCBCDEJB5/StatefulBeanExample!com.scbcd.ejbs.StatefulBeanRemote, java:global/SCBCDEAR5/SCBCDEJB5/StatefulBeanExample!com.scbcd.ejbs.StatefulBeanExample]
INFO: Glassfish-specific (Non-portable) JNDI names for EJB StatefulBeanExample : [com.scbcd.ejbs.StatefulBeanRemote#com.scbcd.ejbs.StatefulBeanRemote, com.scbcd.ejbs.StatefulBeanRemote]
INFO: ACDEPL103: Java Web Start services started for the app client SCBCDEAR5/SCBCDEAR5-app-client.jar (contextRoot: /SCBCDEAR5/SCBCDEAR5-app-client)
INFO: SCBCDEAR5 was successfully deployed in 687 milliseconds.
INFO: ACDEPL104: Java Web Start services stopped for the app client SCBCDEAR5/SCBCDEAR5-app-client.jar
INFO: Portable JNDI names for EJB StatefulBeanExample : [java:global/SCBCDEAR5/SCBCDEJB5/StatefulBeanExample!com.scbcd.ejbs.StatefulBeanRemote, java:global/SCBCDEAR5/SCBCDEJB5/StatefulBeanExample!com.scbcd.ejbs.StatefulBeanExample]
INFO: Glassfish-specific (Non-portable) JNDI names for EJB StatefulBeanExample : [com.scbcd.ejbs.StatefulBeanRemote#com.scbcd.ejbs.StatefulBeanRemote, com.scbcd.ejbs.StatefulBeanRemote]
INFO: ACDEPL103: Java Web Start services started for the app client SCBCDEAR5/SCBCDEAR5-app-client.jar (contextRoot: /SCBCDEAR5/SCBCDEAR5-app-client)
INFO: SCBCDEAR5 was successfully deployed in 953 milliseconds.
INFO: postConstruct called
INFO: Business method 100
INFO: java:comp/env/com.scbcd.ejbs.StatefulBeanExample: com.sun.enterprise.naming.impl.JavaURLContext
INFO: java:comp/env/: com.sun.enterprise.naming.impl.JavaURLContext

envEntry variable is not binding anywhere?

[Ralph Jaus]

To my knowledge

@Resource int envEntry=99;

works as follows: If there is a corresponding entry in DD then the value is taken from DD, otherwise the default is taken. But in contrast to other resources no entry in the beans ENC is created. Therefore the lookup fails. If you inject for example

@PersistenceContext private EntityManager em;

the following returns an entity manager object:

ic.lookup("java:comp/env/com.scbcd.ejbs.StatefulBeanExample/em");

[Umakanth Godavarthy]

The ejb-spec (section 16.4.1.3, page 413) says:"To support this case, the container must only inject a value for the environment entry if the application
assembler or deployer has specified a value to override the default value. The env-entry-value
element in the deployment descriptor is optional when an injection target is specified. If the element is
not specified, no value will be injected. In addition, if the element is not specified, the named resource is
not initialized in the naming context, and explicit lookups of the named resource will fail."
So it is clear that if env-entry-value is not specified it doesn't bind to the naming context.
But the below statement in the spec (section 16.4.1.2, page 408): "This may be done by means of the EJBContext lookup method or by direct use of the
JNDI interfaces. The environment entries are declared by the Bean Provider by means of annotations on
the bean class or in the deployment descriptor."
This is bit contradicting to the previous statement as, if env entries are not specified in DD it is not accessible though context lookups.

[Ralph Jaus]

umakanth godavarthy wrote:This is bit contradicting to the previous statement as, if env entries are not specified in DD it is not accessible though context lookups.

Yes, I agree. But environment entries are the only exception from this rule. An explanation might be:

Entries in the ENC (the ejb's jndi subdirectory) are created during deployment. When a bean instance is created the
container performs a JNDI lookup on the ENC and assigns the retrieved object to the injection target (e.g. the annotated
instance variable).

Now assume there is no entry in the ENC. What should the container do ?

The simplest solution would be to allow default values. That works pretty fine with types that are independent of the
container's environment, such as environment entry types (String, Integer, etc). But what should be the default value of

@PersistenceContext EntityManager em; ?

It had to be something like

@PersistenceContext EntityManager em = new HibernateEntityManagerImpl();

But then the bean code depends on the container's environment, breaking EJB's philosophy of platform-independence.
Therefore default values are no option for such types. So for these types we need entries in ENC (in contrast to
environment entry types).

On the other hand, if we have

@Resource int = 3;

(and no DD entry) it would surely be possible for the container (in principal) to generate a corresponding entry in ENC like
it must be done for the other types. But what would be the usage of it ?

[Siva Masilamani]

Thanks everyone for helping me to understand this..

It seems that i need to go through specification word by word instead of line by line......