com.novell.afw.portal.proxy
Class EboPortletContainerProxy

java.lang.Object
 |
 +--com.novell.afw.portal.proxy.EboPortletContainerProxy

All Implemented Interfaces:

EbiProxyConstants

public class EboPortletContainerProxy

extends Object

implements EbiProxyConstants

This is the portlet container proxy class that sends portlet requests to the underlying containers to perform run-time operation on the specified portlet, component, or remote portlet.

Since:

v5.0

See Also:

EbiPortletContainer, EbiPortletContainerLocal, EbiPortletConsumerContainer, EbiComponentContainer, com.novell.afw.wsrp.consumer.api.EbiWSRPConsumerContainer

Fields inherited from interface com.novell.afw.portal.proxy.EbiProxyConstants

COMPONENT_CONTAINER, COMPONENT_CONTAINER_ENABLE_KEY, COMPONENT_PORTLET_TYPE, PORTLET_CONSUMER_CONTAINER, PORTLET_CONTAINER, PORTLET_CONTAINER_ENABLE_KEY, STANDARD_PORTLET_TYPE, WSRP_CONSUMER_CONTAINER, WSRP_CONSUMER_ENABLE_KEY, WSRP_PORTLET_TYPE

Constructor Summary

EboPortletContainerProxy()

Method Summary

EbiMarkupResponse	getMarkup(EbiPortalContext context, EbiPortletEntity entity, EbiMarkupParams mparams, EbiRuntimeContext runtimeContext) Gets a markup fragment for a portlet specified by a EbiPortletEntity object.
EbiPortletContainer	getPortletContainer(ServletContext context, String containerType) Gets a portlet container by a container type.
EboPortletRegistryProxy	getPortletRegistryProxy() Gets the PortletRegistryProxy object which handles generic registration operations.
boolean	isContainerEnabled(String containerType) Checks to see if the specified container type is enabled.
EbiBlockingInteractionResponse	performBlockingInteraction(EbiPortalContext context, EbiPortletEntity entity, EbiMarkupParams mparams, EbiInteractionParams iparams) Performs a portlet interaction for a protlet specified by an EbiPortletEntity object.
void	triggerTimeOut(Long processID) Triggers timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

EboPortletContainerProxy

public EboPortletContainerProxy()

Method Detail

triggerTimeOut

public void triggerTimeOut(Long processID)

Triggers timeout.

Parameters:

processID - a portlet process ID (for the thread that performs a getMarkup() operation on a portlet).

Since:

v5.0

isContainerEnabled

public boolean isContainerEnabled(String containerType)

Checks to see if the specified container type is enabled.

Since:

v5.0

performBlockingInteraction

public EbiBlockingInteractionResponse performBlockingInteraction(EbiPortalContext context,
                                                                 EbiPortletEntity entity,
                                                                 EbiMarkupParams mparams,
                                                                 EbiInteractionParams iparams)
                                                          throws EboUnrecoverableSystemException,
                                                                 EboSecurityException,
                                                                 com.novell.afw.portlet.exception.EboPortletOperationException

Performs a portlet interaction for a protlet specified by an EbiPortletEntity object.

Parameters:

context - an EbiPortalContext object

entity - an EbiPortletEntity object

mparams - an EbiMarkupParams object

iparams - an EbiInteractionParams object

Returns:

an EbiBlockingInteractionResponse object.

Since:

v5.0

See Also:

EbiMarkupParams, EbiInteractionParams, com.novell.afw.portlet.api.EbiBlockingIteractionRsponse, com.novell.portlet.api.EbiPortletEntity

getMarkup

public EbiMarkupResponse getMarkup(EbiPortalContext context,
                                   EbiPortletEntity entity,
                                   EbiMarkupParams mparams,
                                   EbiRuntimeContext runtimeContext)
                            throws EboUnrecoverableSystemException,
                                   EboSecurityException,
                                   com.novell.afw.portlet.exception.EboPortletOperationException

Gets a markup fragment for a portlet specified by a EbiPortletEntity object.

Parameters:

context - an EbiPortalContext object

entity - an EbiPortletEntity object

mparams - an EbiMarkupParams object

Returns:

a EbiMarkupResponse object.

Since:

v5.0

See Also:

EbiMarkupParams, EbiMarkupResponse, EbiPortletEntity

getPortletContainer

public EbiPortletContainer getPortletContainer(ServletContext context,
                                               String containerType)

Gets a portlet container by a container type. If type is unspecified, return the default portlet container. The supported container types are defined by PortletConstants. If the returned object is null, then this container is not enabled by associated Portal WAR.

Parameters:

context - a ServletContext

containerType - a container type, defined in ProxyConstants.

Returns:

a EbiPortletContainer object for the specified ServletContext object and the container type.

Since:

v5.0

See Also:

EbiProxyConstants

getPortletRegistryProxy

public EboPortletRegistryProxy getPortletRegistryProxy()

Gets the PortletRegistryProxy object which handles generic registration operations.

Returns:

a PortletRegistryProxy object.

Since:

v5.0

See Also:

EboPortletRegistryProxy