FileDocCategorySizeDatePackage
EJBContext.javaAPI DocGlassfish v2 API8255Fri May 04 22:35:54 BST 2007javax.ejb

EJBContext

public interface EJBContext
The EJBContext interface provides an instance with access to the container-provided runtime context of an enterprise Bean instance.

This interface is extended by the SessionContext, EntityContext, and MessageDrivenContext interfaces to provide additional methods specific to the enterprise interface Bean type.

Fields Summary
Constructors Summary
Methods Summary
public java.security.IdentitygetCallerIdentity()
Obtain the java.security.Identity of the caller. This method is deprecated in EJB 1.1. The Container is allowed to return alway null from this method. The enterprise bean should use the getCallerPrincipal method instead.

return
The Identity object that identifies the caller.
deprecated
Use Principal getCallerPrincipal() instead.

public java.security.PrincipalgetCallerPrincipal()
Obtain the java.security.Principal that identifies the caller.

return
The Principal object that identifies the caller. This method never returns null.
exception
IllegalStateException The Container throws the exception if the instance is not allowed to call this method.

public EJBHomegetEJBHome()
Obtain the enterprise bean's remote home interface.

return
The enterprise bean's remote home interface.
exception
java.lang.IllegalStateException if the enterprise bean does not have a remote home interface.

public EJBLocalHomegetEJBLocalHome()
Obtain the enterprise bean's local home interface.

return
The enterprise bean's local home interface.
exception
java.lang.IllegalStateException if the enterprise bean does not have a local home interface.

public java.util.PropertiesgetEnvironment()
Obtain the enterprise bean's environment properties.

Note: If the enterprise bean has no environment properties this method returns an empty java.util.Properties object. This method never returns null.

return
The environment properties for the enterprise bean.
deprecated
Use the JNDI naming context java:comp/env to access enterprise bean's environment.

public booleangetRollbackOnly()
Test if the transaction has been marked for rollback only. An enterprise bean instance can use this operation, for example, to test after an exception has been caught, whether it is fruitless to continue computation on behalf of the current transaction. Only enterprise beans with container-managed transactions are allowed to use this method.

return
True if the current transaction is marked for rollback, false otherwise.
exception
IllegalStateException The Container throws the exception if the instance is not allowed to use this method (i.e. the instance is of a bean with bean-managed transactions).

public TimerServicegetTimerService()
Get access to the EJB Timer Service.

exception
IllegalStateException The Container throws the exception if the instance is not allowed to use this method (e.g. if the bean is a stateful session bean)

public javax.transaction.UserTransactiongetUserTransaction()
Obtain the transaction demarcation interface. Only enterprise beans with bean-managed transactions are allowed to to use the UserTransaction interface. As entity beans must always use container-managed transactions, only session beans or message-driven beans with bean-managed transactions are allowed to invoke this method.

return
The UserTransaction interface that the enterprise bean instance can use for transaction demarcation.
exception
IllegalStateException The Container throws the exception if the instance is not allowed to use the UserTransaction interface (i.e. the instance is of a bean with container-managed transactions).

public booleanisCallerInRole(java.security.Identity role)
Test if the caller has a given role.

This method is deprecated in EJB 1.1. The enterprise bean should use the isCallerInRole(String roleName) method instead.

param
role The java.security.Identity of the role to be tested.
return
True if the caller has the specified role.
deprecated
Use boolean isCallerInRole(String roleName) instead.

public booleanisCallerInRole(java.lang.String roleName)
Test if the caller has a given security role.

param
roleName The name of the security role. The role must be one of the security roles that is defined in the deployment descriptor.
return
True if the caller has the specified role.
exception
IllegalStateException The Container throws the exception if the instance is not allowed to call this method.

public java.lang.Objectlookup(java.lang.String name)
Lookup a resource within the component's private naming context.

param
name Name of the entry (relative to java:comp/env).
exception
IllegalArgumentException The Container throws the exception if the given name does not match an entry within the component's environment.

public voidsetRollbackOnly()
Mark the current transaction for rollback. The transaction will become permanently marked for rollback. A transaction marked for rollback can never commit. Only enterprise beans with container-managed transactions are allowed to use this method.

exception
IllegalStateException The Container throws the exception if the instance is not allowed to use this method (i.e. the instance is of a bean with bean-managed transactions).