com.sssw.portal.factory
Class EboFactory

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

All Implemented Interfaces:

Serializable

public class EboFactory

extends Object

implements Serializable

This is the portal factory class that manages portal objects. One portal factory exists per portal web application

See Also:

Serialized Form

Constructor Summary

EboFactory()

Method Summary

static EbiComponentOptionInfo	createComponentOptionInfo(Node optionElement) Creates an empty EbiComponentOptionInfo element
static EbiPortalContext	createPortalContext(EbiRequestContext fwContext) Creates a portal context from a request context.
static EbiPortalContext	createPortalContext(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext) Gets the EbiPortalContext object that is associated with the portal web application.
static EbiThemeInfo	createThemeInfo(String themeID, Node descriptor) Creates a EbiThemeInfo object give a valid XML document
static EbiActionHandler	getActionHandler(EbiPortalContext context) Gets the EbiOptionManager object that is associated with the portal web application.
static EbiComponentManager	getComponentManager(EbiPortalContext context) Gets the EbiComponentManager object that is associated with the portal web application.
static com.sssw.portal.api.EbiDeviceManager	getDeviceManager(EbiPortalContext context) Gets the EbiDeviceManager object that is associated with the portal web application.
static EbiLayoutManager	getLayoutManager(EbiPortalContext context) Gets the EbiLayoutManager object that is associated with the portal web application.
static EbiOptionManager	getOptionManager(EbiPortalContext context) Gets the EbiOptionManager object that is associated with the portal web application.
static EbiPageLayoutHandler	getPageLayoutHandler() Gets a new EbiPageLayoutHandler object.
static EbiPageManager	getPageManager(EbiPortalContext context) Gets the EbiPageManager object that is associated with the portal web application.
static EbiPortalAuthenticator	getPortalAuthenticator(EbiPortalContext context) Gets the EbiPortalAuthenticator object that is associated with the portal web application.
static com.novell.afw.portal.api.EbiPortalCategoryManager	getPortalCategoryManager(EbiContext context) Gets the EbiPortalCategoryManager object that is associated with the portal web application.
static EbiPortalDecorator	getPortalDecorator(EbiPortalContext context) Gets the Default portal decorator
static EbiPortalManager	getPortalManager(EbiPortalContext context) Gets the EbiPortalManager object that is associated with the portal web application.
static com.sssw.portal.api.EbiPresentationManager	getPresentationManager(EbiPortalContext context) Gets the EbiPresentationManager object that is associated with the portal web application.
static com.sssw.portal.api.EbiProfilingManager	getProfilingManager(EbiPortalContext context) Gets the EbiProfilingManager object that is associated with the portal web application.
static EbiStyleManager	getStyleManager(EbiPortalContext context) Gets the EbiStyleManager object that is associated with the portal web application.
static EbiThemeManager	getThemeManager(EbiPortalContext context) Gets the EbiThemeManager object that is associated with the portal web application.

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

getStyleManager

public static EbiStyleManager getStyleManager(EbiPortalContext context)
                                       throws EboFactoryException

Gets the EbiStyleManager object that is associated with the portal web application. The framework maintains one EbiStyleManager per web application.

Parameters:

context -

Returns:

the style manager for the current web application

Throws:

EboFactoryException - thrown if unable to obtain the manager

getLayoutManager

public static EbiLayoutManager getLayoutManager(EbiPortalContext context)
                                         throws EboFactoryException

Gets the EbiLayoutManager object that is associated with the portal web application. The framework maintains one EbiLayoutManager per web application.

Parameters:

context - The portal's context object

Returns:

the portal's singleton layout manager instance

Throws:

EboFactoryException - thrown if unable to obtain the manager

Since:

v4.0

See Also:

EbiLayoutManager

getThemeManager

public static EbiThemeManager getThemeManager(EbiPortalContext context)
                                       throws EboFactoryException

Gets the EbiThemeManager object that is associated with the portal web application. The framework maintains one EbiThemeManager per web application.

Parameters:

context - The portal's context object

Returns:

the portal's singleton theme manager instance

Throws:

EboFactoryException - thrown if unable to obtain the manager

Since:

v4.0

See Also:

EbiThemeManager

getActionHandler

public static EbiActionHandler getActionHandler(EbiPortalContext context)
                                         throws EboFactoryException

Gets the EbiOptionManager object that is associated with the portal web application.

The framework maintains one EbiOptionManager per web application. The option manager manages the options but does not handle how the options are linked to the components. The component manager, EbiComponentManager ,manages the relationship between options and components.

Parameters:

context - The portal's context object

Returns:

the portal's singleton option manager instance

Throws:

EboFactoryException - thrown if unable to obtain the manager

Since:

v4.0

See Also:

EbiOptionManager

getPortalDecorator

public static EbiPortalDecorator getPortalDecorator(EbiPortalContext context)
                                             throws EboFactoryException

Gets the Default portal decorator

The framework maintains one default portal decorator per web application. The presentation manager uses this decorator to decorate all components that do not implment EbiPortalDecorator themselves.

Parameters:

context - The portal's context object

Returns:

the portal's singleton default decorator

Throws:

EboFactoryException - thrown if unable to obtain the decorator

Since:

v4.0

See Also:

EbiPortalDecorator, com.sssw.portal.core.EboDefaultPortalDecorator, com.sssw.portal.core.EboComponentDecorator

getOptionManager

public static EbiOptionManager getOptionManager(EbiPortalContext context)
                                         throws EboFactoryException

Gets the EbiOptionManager object that is associated with the portal web application.

The framework maintains one EbiOptionManager per web application. The option manager manages the options but does not handle how the options are linked to the components. The component manager, EbiComponentManager ,manages the relationship between options and components.

Parameters:

context - The portal's context object

Returns:

the portal's singleton option manager instance

Throws:

EboFactoryException - thrown if unable to obtain the manager

Since:

v4.0

See Also:

EbiOptionManager

getComponentManager

public static EbiComponentManager getComponentManager(EbiPortalContext context)
                                               throws EboFactoryException

Gets the EbiComponentManager object that is associated with the portal web application. The framework maintains one EbiComponentManager per web application.

Parameters:

context -

Returns:

the component manager for the current web application

Throws:

EboFactoryException - thrown if unable to obtain the manager

getPageManager

public static EbiPageManager getPageManager(EbiPortalContext context)
                                     throws EboFactoryException

Gets the EbiPageManager object that is associated with the portal web application. The framework maintains one EbiPageManager per web application.

Parameters:

context -

Returns:

the page manager for the current web application

Throws:

EboFactoryException - thrown if unable to obtain the manager

getPortalCategoryManager

public static com.novell.afw.portal.api.EbiPortalCategoryManager getPortalCategoryManager(EbiContext context)
                                                                                   throws EboFactoryException

Gets the EbiPortalCategoryManager object that is associated with the portal web application. The framework maintains one EbiPortalCategoryManager per web application.

Parameters:

context -

Returns:

the portal category manager for the current web application

Throws:

EboFactoryException - thrown if unable to obtain the manager

getDeviceManager

public static com.sssw.portal.api.EbiDeviceManager getDeviceManager(EbiPortalContext context)
                                                             throws EboFactoryException

Gets the EbiDeviceManager object that is associated with the portal web application. The framework maintains one EbiDeviceManager per web application

Parameters:

context -

Returns:

the device manager for the current web application

Throws:

EboFactoryException - thrown if unable to obtain the manager

getProfilingManager

public static com.sssw.portal.api.EbiProfilingManager getProfilingManager(EbiPortalContext context)
                                                                   throws EboFactoryException

Gets the EbiProfilingManager object that is associated with the portal web application. The framework maintains one EbiProfilingManager per web application

Parameters:

context -

Returns:

the device profile manager for the current web application

Throws:

EboFactoryException - thrown if unable to obtain the manager

getPresentationManager

public static com.sssw.portal.api.EbiPresentationManager getPresentationManager(EbiPortalContext context)
                                                                         throws EboFactoryException

Gets the EbiPresentationManager object that is associated with the portal web application. The framework maintains one EbiPresentationManager per web application.

Parameters:

context -

Returns:

tje presentation manager for the current web application

Throws:

EboFactoryException - thrown if unable to obtain the manager

getPortalManager

public static EbiPortalManager getPortalManager(EbiPortalContext context)
                                         throws EboFactoryException

Gets the EbiPortalManager object that is associated with the portal web application. The framework maintains one EbiPortalManager per web application.

Parameters:

context -

Returns:

the portal manager for the current web application

Throws:

EboFactoryException - thrown if unable to obtain the manager

getPageLayoutHandler

public static EbiPageLayoutHandler getPageLayoutHandler()
                                                 throws EboFactoryException

Gets a new EbiPageLayoutHandler object. This object must be associated with either an EbiUserPageInfo object or EbiGroupPageInfo object to manage the sections and selected components for the user or group page.

Returns:

a new page layout handler

Throws:

EboFactoryException - thrown if unable to obtain a new page handler

getPortalAuthenticator

public static EbiPortalAuthenticator getPortalAuthenticator(EbiPortalContext context)
                                                     throws EboFactoryException

Gets the EbiPortalAuthenticator object that is associated with the portal web application. The framework maintains one EbiPortalAuthenticator per web application.

Parameters:

context -

Returns:

the portal authenticator for the current web application

Throws:

EboFactoryException - thrown if unable to obtain the portal authenticator

createPortalContext

public static EbiPortalContext createPortalContext(HttpServletRequest request,
                                                   HttpServletResponse response,
                                                   ServletContext servletContext)
                                            throws EboFactoryException

Gets the EbiPortalContext object that is associated with the portal web application. The framework creates a new EbiPortalContext each time this method is called. In general it is good practice to create one EbiPortalContext per http request.

Parameters:

request -

response -

servletContext -

Returns:

a new portal context

Throws:

EboFactoryException - thrown if unable to obtain a new portal context

createPortalContext

public static EbiPortalContext createPortalContext(EbiRequestContext fwContext)
                                            throws EboFactoryException

Creates a portal context from a request context.

Parameters:

reqContext - an EbiRequestContext object.

Returns:

an EbiPortalContext object.

Throws:

EboFactoryException - thrown if unable to convert it to a new portal context

createComponentOptionInfo

public static EbiComponentOptionInfo createComponentOptionInfo(Node optionElement)
                                                        throws EboFactoryException

Creates an empty EbiComponentOptionInfo element

Parameters:

optionElement - a node which contains the information to initialize the option info see portal-option_4_0.dtd

Returns:

An empty EbiComponentOptionInfo object

Throws:

EboFactoryException -

Since:

v4.0

createThemeInfo

public static EbiThemeInfo createThemeInfo(String themeID,
                                           Node descriptor)
                                    throws EboFactoryException

Creates a EbiThemeInfo object give a valid XML document

Parameters:

themeID -

descriptor - the data to be used when creating the theme info. See portal-theme_4_0.dtd

Returns:

a new EbiThemInfo

Throws:

EboFactoryException -

Since:

v4.0