javax.ejb
Interface EJBContext
- All Known Subinterfaces:
- EntityContext, SessionContext
- public abstract 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 and EntityContext
interface to provide additional methods specific to the enterprise
Bean type.
Method Summary |
java.security.Identity |
getCallerIdentity()
Deprecated. Use Principal getCallerPrincipal() instead. |
java.security.Principal |
getCallerPrincipal()
Obtain the java.security.Principal that identifies the caller. |
EJBHome |
getEJBHome()
Obtain the enterprise bean's home interface. |
java.util.Properties |
getEnvironment()
Deprecated. Use the JNDI naming context java:comp/env to access
enterprise bean's environment. |
boolean |
getRollbackOnly()
Test if the transaction has been marked for rollback only. |
javax.transaction.UserTransaction |
getUserTransaction()
Obtain the transaction demarcation interface. |
boolean |
isCallerInRole(java.security.Identity role)
Deprecated. Use boolean isCallerInRole(String roleName) instead. |
boolean |
isCallerInRole(java.lang.String roleName)
Test if the caller has a given security role. |
void |
setRollbackOnly()
Mark the current transaction for rollback. |
getEJBHome
public EJBHome getEJBHome()
- Obtain the enterprise bean's home interface.
- Returns:
- The enterprise bean's home interface.
getEnvironment
public java.util.Properties getEnvironment()
- Deprecated. Use the JNDI naming context java:comp/env to access
enterprise bean's environment.
- 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.
- Returns:
- The environment properties for the enterprise bean.
getCallerIdentity
public java.security.Identity getCallerIdentity()
- Deprecated. Use Principal getCallerPrincipal() instead.
- 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.
- Returns:
- The Identity object that identifies the caller.
getCallerPrincipal
public java.security.Principal getCallerPrincipal()
- Obtain the java.security.Principal that identifies the caller.
- Returns:
- The Principal object that identifies the caller.
isCallerInRole
public boolean isCallerInRole(java.security.Identity role)
- Deprecated. Use boolean isCallerInRole(String roleName) instead.
- 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.
- Parameters:
role
- The java.security.Identity of the role to be tested.- Returns:
- True if the caller has the specified role.
isCallerInRole
public boolean isCallerInRole(java.lang.String roleName)
- Test if the caller has a given security role.
- Parameters:
roleName
- The name of the security role. The role must be one of
the security roles that is defined in the deployment descriptor.- Returns:
- True if the caller has the specified role.
getUserTransaction
public javax.transaction.UserTransaction getUserTransaction()
throws java.lang.IllegalStateException
- 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 with bean-managed
transactions are allowed to invoke this method.
- Returns:
- The UserTransaction interface that the enterprise bean
instance can use for transaction demarcation.
- Throws:
- java.lang.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).
setRollbackOnly
public void setRollbackOnly()
throws java.lang.IllegalStateException
- 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.
- Throws:
- java.lang.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).
getRollbackOnly
public boolean getRollbackOnly()
throws java.lang.IllegalStateException
- 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.
- Returns:
- True if the current transaction is marked for rollback, false
otherwise.
- Throws:
- java.lang.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).