org.sape.carbon.services.ejb.local
Interface LocalHomeFactory

All Superinterfaces:

FunctionalInterface

All Known Implementing Classes:

LocalHomeFactoryImpl

public interface LocalHomeFactory

extends FunctionalInterface

This interface defines the functional APIs for a home factory component that provides facilities for retrieving the home interfaces of locally deployed Enterprise Java Beans (EJBLocalHome objects).

Copyright 2002 Sapient

Since:

carbon 1.0

Version:

$Revision: 1.6 $($Author: dvoet $ / $Date: 2003/05/05 21:21:28 $)

Author:

Erik M Gottesman, June 2002

Method Summary

EnterpriseBeanConfiguration	getEJBDetails(String logicalName) Utility method for retrieving an EJB's configuration information as declared in the associated configuration.
javax.ejb.EJBLocalHome	lookup(String logicalName) Handles JNDI lookups for locally deployed EJBs using the default context properties declared in the associated configuration.
javax.ejb.EJBLocalHome	lookup(String logicalName, Context context) Handles JNDI lookups for locally deployed EJBs using a context object specified at run-time.
javax.ejb.EJBLocalHome	lookup(String logicalName, String principal, String credentials) Handles JNDI lookups for locally deployed EJBs using the default context properties declared in the associated configuration with the exception of the security principal and credentials which are passed at run-time.

Method Detail

lookup

public javax.ejb.EJBLocalHome lookup(String logicalName)
                              throws HomeFactoryException

Handles JNDI lookups for locally deployed EJBs using the default context properties declared in the associated configuration.

Parameters:

logicalName - String representation of the EJB's logical name in JNDI

Returns:

EJBLocalHome The home interface object for the local EJB

Throws:

HomeFactoryException - Wraps any checked exception that occurs during the JNDI lookup

lookup

public javax.ejb.EJBLocalHome lookup(String logicalName,
                                     Context context)
                              throws HomeFactoryException

Handles JNDI lookups for locally deployed EJBs using a context object specified at run-time.

Parameters:

logicalName - String representation of the EJB's logical name in JNDI

context - A javax.naming.Context object to be used in performing the JNDI lookup

Returns:

EJBLocalHome The home interface object for the local EJB

Throws:

HomeFactoryException - Wraps any checked exception that occurs during the JNDI lookup

lookup

public javax.ejb.EJBLocalHome lookup(String logicalName,
                                     String principal,
                                     String credentials)
                              throws HomeFactoryException

Handles JNDI lookups for locally deployed EJBs using the default context properties declared in the associated configuration with the exception of the security principal and credentials which are passed at run-time.

Parameters:

logicalName - a String representation of the EJB's logical name in JNDI

principal - String representation of the security principal

credentials - The credentials associated with the security principal in String format

Returns:

EJBLocalHome The home interface object for the local EJB

Throws:

HomeFactoryException - Wraps any checked exception that occurs during the JNDI lookup

getEJBDetails

public EnterpriseBeanConfiguration getEJBDetails(String logicalName)

Utility method for retrieving an EJB's configuration information as declared in the associated configuration.

Parameters:

logicalName - String representation of the EJB's logical name in JNDI

Returns:

EnterpriseBeanConfiguration An encapsulation of the EJB's declared configuration details