com.sssw.fw.factory
Class EboFactory

java.lang.Object
 |
 +--com.sssw.fw.factory.EboFactory

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

EboScopedPathFactory

public class EboFactory

extends Object

implements Serializable

This is the portal factory class that manages portal objects

See Also:

Serialized Form

Constructor Summary

EboFactory()

Method Summary

static EbiContext	createEbiContext() Creates an EbiContext object.
static EbiContext	createEbiContext(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, javax.portlet.PortletContext ctxt) Creates an EbiContext object that is associatd with portlet action request and response.
static EbiContext	createEbiContext(EbiSession session) Creates an EbiContext object that is associated with an EbiSession object.
static EbiContext	createEbiContext(com.sssw.fw.factory.EJBContext ejbctx) Creates an EbiContext object that is associated with an ejb context.
static EbiContext	createEbiContext(HttpServletRequest request, HttpServletResponse response, ServletContext servletCtx) Creates an EbiContext object that is associatd with http request and response.
static EbiContext	createEbiContext(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response, javax.portlet.PortletContext ctxt) Creates an EbiContext object that is associatd with portlet render request and response.
static EbiScopedPath	createScopedPath(String scopedPath) Creates an EbiScopedPath object.
static EbiCacheManager	getCacheManager() Gets Cache Manager singleton object.
static EbiConfig	getConfig() Gets the config object for the portal.
static EbiDelegate	getDelegate(String delegateType) Gets an EbiDelegate object.
static EbiDelegate	getDelegate(String delegateType, String serviceLocation) Gets an EbiDelegate object.
static EbiElement	getElement(String elementType) Gets an EbiElement element object.
static EbiSrvLifetimeCacheHolder	getGlobalCacheHolder() Gets the global EbiCacheHolder object.
static com.sssw.fw.persist.jdbc.api.EbiJdbcMetaDataQuery	getJdbcMetaDataQuery(String queryType) Gets an EbiJdbcMetaDataQuery object.
static com.sssw.fw.persist.jdbc.api.EbiJdbcMetaDataQuery	getJdbcMetaDataQuery(String queryType, String dataSource) Gets an EbiJdbcMetaDataQuery object.
static com.sssw.fw.persist.jdbc.api.EbiJdbcQuery	getJdbcQuery(String queryType) Gets an EbiJdbcQuery object.
static com.sssw.fw.persist.jdbc.api.EbiJdbcQuery	getJdbcQuery(String queryType, String dataSource) Gets an EbiJdbcQuery object.
static com.sssw.fw.persist.jndi.api.EbiJndiMetaDataQuery	getJndiMetaDataQuery(String queryType) Gets an EbiJndiMetaDataQuery object.
static com.sssw.fw.persist.jndi.api.EbiJndiQuery	getJndiQuery(String queryType) Gets an EbiJndiQuery object.
static EbiQuery	getQuery(String queryType) Gets an EbiQuery object.
static EbiSrvLifetimeCacheHolder	getServerLifetimeCacheHolder(String cacheHolderID) Gets a server lifetime cache holder object.
static EbiSrvLifetimeCacheHolder	getServerLifetimeCacheHolder(String cacheHolderType, String cacheHolderID) Gets a server lifetime cache holder object.
static EbiServiceLocator	getServiceLocator() Gets the ServiceLocator singleton.
static com.sssw.fw.api.EbiSessionManager	getSessionManager() Gets Session Manager singleton object.
static Map	getStartsWith(String startsWith) Gets all services that start with the specified string.
static EbiThreadPoolManager	getThreadPoolManager() Gets the ThreadPool Mananger.
static void	loadServices(InputStream in) Deprecated. Please use the signature of this method that takes the subsystem name.
static void	loadServices(InputStream in, String namespace) Deprecated. Please use the signature of this method that takes the subsystem name.
static void	loadServices(String subsystemName, InputStream in) Adds services to the current factory.
static void	loadServices(String subsystemName, String namespace, InputStream in) Adds services to the current factory with the given namespace.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EboFactory

public EboFactory()

Method Detail

getThreadPoolManager

public static EbiThreadPoolManager getThreadPoolManager()
                                                 throws EboFactoryException

Gets the ThreadPool Mananger.

Returns:

an EbiThreadPoolManager.

getCacheManager

public static EbiCacheManager getCacheManager()
                                       throws EboFactoryException

Gets Cache Manager singleton object.

Returns:

an EbiCacheManager object.

getSessionManager

public static com.sssw.fw.api.EbiSessionManager getSessionManager()
                                                           throws EboFactoryException

Gets Session Manager singleton object.

Returns:

an EbiSessionManager object.

getConfig

public static EbiConfig getConfig()

Gets the config object for the portal.

Returns:

an EbiConfig object.

loadServices

public static void loadServices(InputStream in)
                         throws EboFactoryException

Deprecated. Please use the signature of this method that takes the subsystem name.

Adds services to the current factory. Since there is no subsystem name, this method will add the services with no subsystem association.

Parameters:

in - An inputstream to a valid services xml document

See Also:

EboFactory.loadServices(java.lang.String, java.io.InputStream)

loadServices

public static void loadServices(InputStream in,
                                String namespace)
                         throws EboFactoryException

Deprecated. Please use the signature of this method that takes the subsystem name.

Adds services to the current factory with the given namespace. Since there is no subsystem name, this method will add the services with no subsystem association.

Parameters:

in - An inputstream to a valid services xml document

namespace - the namespace prefix to prepend to the service ID for services which are specified to be namespaced by the services file

See Also:

EboFactory.loadServices(java.lang.String, java.lang.String, java.io.InputStream)

loadServices

public static void loadServices(String subsystemName,
                                String namespace,
                                InputStream in)
                         throws EboFactoryException

Adds services to the current factory with the given namespace. It also categorizes the services to the subsystem name passed in. This association provides a way to manage a single subsystem's services.

Parameters:

subsystemName - String name of the subsystem to associate with the services. This should not be null, and if it is, an NPE will be thrown.

namespace - the namespace prefix to prepend to the service ID for services which are specified to be namespaced by the services file

in - An inputstream to a valid services xml document

loadServices

public static void loadServices(String subsystemName,
                                InputStream in)
                         throws EboFactoryException

Adds services to the current factory. It also categorizes the services to the subsystem name passed in. This association provides a way to manage a single subsystem's services.

Parameters:

subsystemName - String name of the subsystem to associate with the services. This should not be null, and if it is, an NPE will be thrown.

in - An inputstream to a valid services xml document

getElement

public static EbiElement getElement(String elementType)
                             throws EboFactoryException

Gets an EbiElement element object.

Parameters:

elementType - interface of the specified element.

Returns:

an EbiElement object.

createScopedPath

public static EbiScopedPath createScopedPath(String scopedPath)
                                      throws EboFactoryException

Creates an EbiScopedPath object.

Parameters:

scopedPath - string representing the desired scoped path

Returns:

an EbiScopedPath object.

createEbiContext

public static EbiContext createEbiContext()
                                   throws EboFactoryException

Creates an EbiContext object.

Returns:

an EbiContext object.

createEbiContext

public static EbiContext createEbiContext(javax.portlet.RenderRequest request,
                                          javax.portlet.RenderResponse response,
                                          javax.portlet.PortletContext ctxt)
                                   throws EboFactoryException

Creates an EbiContext object that is associatd with portlet render request and response.

Parameters:

request - a portlet render request.

response - a portlet render response.

ctxt - the PortletContext

Returns:

an EbiContext object.

createEbiContext

public static EbiContext createEbiContext(javax.portlet.ActionRequest request,
                                          javax.portlet.ActionResponse response,
                                          javax.portlet.PortletContext ctxt)
                                   throws EboFactoryException

Creates an EbiContext object that is associatd with portlet action request and response.

Parameters:

request - a portlet action request.

response - a portlet action response.

ctxt - the PortletContext

Returns:

an EbiContext object.

createEbiContext

public static EbiContext createEbiContext(HttpServletRequest request,
                                          HttpServletResponse response,
                                          ServletContext servletCtx)
                                   throws EboFactoryException

Creates an EbiContext object that is associatd with http request and response.

Parameters:

request - an http request.

response - an http response.

servletCtx - a Servlet Context.

Returns:

an EbiContext object.

createEbiContext

public static EbiContext createEbiContext(com.sssw.fw.factory.EJBContext ejbctx)
                                   throws EboFactoryException

Creates an EbiContext object that is associated with an ejb context.

Parameters:

ejbctx - an EJB context.

Returns:

an EbiContext object.

createEbiContext

public static EbiContext createEbiContext(EbiSession session)
                                   throws EboFactoryException

Creates an EbiContext object that is associated with an EbiSession object.

Parameters:

session - an EbiSession object.

Returns:

an EbiContext object.

getQuery

public static EbiQuery getQuery(String queryType)
                         throws EboFactoryException

Gets an EbiQuery object.

Parameters:

queryType - interface of the specified query object.

Returns:

an EbiQuery object.

getJdbcQuery

public static com.sssw.fw.persist.jdbc.api.EbiJdbcQuery getJdbcQuery(String queryType)
                                                              throws EboFactoryException

Gets an EbiJdbcQuery object.

Parameters:

queryType - interface of the specified JDBC query object.

Returns:

an EbiJdbcQuery object.

getJdbcQuery

public static com.sssw.fw.persist.jdbc.api.EbiJdbcQuery getJdbcQuery(String queryType,
                                                                     String dataSource)
                                                              throws EboFactoryException

Gets an EbiJdbcQuery object.

Parameters:

queryType - interface of the specified JDBC query object.

dataSource - name of the data source for which the query should be formulated.

Returns:

an EbiJdbcQuery object.

getJdbcMetaDataQuery

public static com.sssw.fw.persist.jdbc.api.EbiJdbcMetaDataQuery getJdbcMetaDataQuery(String queryType)
                                                                              throws EboFactoryException

Gets an EbiJdbcMetaDataQuery object.

Parameters:

queryType - interface of the specified JDBC MetaData query object.

Returns:

an EbiJdbcMetaDataQuery object.

getJdbcMetaDataQuery

public static com.sssw.fw.persist.jdbc.api.EbiJdbcMetaDataQuery getJdbcMetaDataQuery(String queryType,
                                                                                     String dataSource)
                                                                              throws EboFactoryException

Gets an EbiJdbcMetaDataQuery object.

Parameters:

queryType - interface of the specified JDBC MetaData query object.

dataSource - name of the data source for which the query should be formulated.

Returns:

an EbiJdbcMetaDataQuery object.

getJndiQuery

public static com.sssw.fw.persist.jndi.api.EbiJndiQuery getJndiQuery(String queryType)
                                                              throws EboFactoryException

Gets an EbiJndiQuery object.

Parameters:

queryType - interface of the specified JNDI query object.

Returns:

an EbiJndiQuery object.

getJndiMetaDataQuery

public static com.sssw.fw.persist.jndi.api.EbiJndiMetaDataQuery getJndiMetaDataQuery(String queryType)
                                                                              throws EboFactoryException

Gets an EbiJndiMetaDataQuery object.

Parameters:

queryType - interface of the specified JNDI query object.

Returns:

an EbiJndiMetaDataQuery object.

getStartsWith

public static Map getStartsWith(String startsWith)

Gets all services that start with the specified string.

Parameters:

startsWith - the prefix string.

Returns:

a Map of services that start with the specified prefix string.

getDelegate

public static EbiDelegate getDelegate(String delegateType)
                               throws EboFactoryException

Gets an EbiDelegate object.

Parameters:

delegateType - interface of the specified delegate object.

Returns:

an EbiDelegate object.

getDelegate

public static EbiDelegate getDelegate(String delegateType,
                                      String serviceLocation)
                               throws EboFactoryException

Gets an EbiDelegate object. This factory method is used to force explicit creation of a local or remote service.

Parameters:

delegateType - interface of the specified delegate object.

serviceLocation - location of the underlying service.

Returns:

an EbiDelegate object.

getServiceLocator

public static EbiServiceLocator getServiceLocator()
                                           throws EboFactoryException

Gets the ServiceLocator singleton.

Returns:

the EbiServiceLocator singleton.

getGlobalCacheHolder

public static EbiSrvLifetimeCacheHolder getGlobalCacheHolder()
                                                      throws EboFactoryException

Gets the global EbiCacheHolder object.

Returns:

an EbiCacheHolder object.

getServerLifetimeCacheHolder

public static EbiSrvLifetimeCacheHolder getServerLifetimeCacheHolder(String cacheHolderID)

Gets a server lifetime cache holder object.

Parameters:

cacheHolderID - cache holder identifier.

Returns:

an EbiSrvLifetimeCacheHolder object.

getServerLifetimeCacheHolder

public static EbiSrvLifetimeCacheHolder getServerLifetimeCacheHolder(String cacheHolderType,
                                                                     String cacheHolderID)

Gets a server lifetime cache holder object.

Parameters:

cacheHolderType - cache holder type (defined in com.sssw.fw.cachemgr.api.EbiCacheConstants)

cacheHolderID - cache holder identifier.

Returns:

an EbiSrvLifetimeCacheHolder object.