org.jasig.portal.channels.portlet
Interface IPortletAdaptor

All Superinterfaces:

ICacheable, IChannel, ICharacterChannel, IDirectResponse, IPrivileged, IPrivilegedChannel, IResetableChannel

All Known Implementing Classes:

CSpringPortletAdaptor

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public interface IPortletAdaptor
extends IResetableChannel, IPrivilegedChannel, ICharacterChannel, ICacheable, IDirectResponse

IChannel interface that describes the required functionality for a portlet. The framework should treat all implementing channels of this type as portlets which includes the following special behaviors: Rendering when minimized Action support

Since:

uPortal 2.5

Field Summary

static PortletMode	ABOUT Deprecated.
static String	ATTRIBUTE__PORTLET_TITLE Deprecated. HttpServletRequest attribute that the adaptor will store the title the portlet dynamically sets under.
static String	ATTRIBUTE__RUNTIME_DATA Deprecated. HttpServletRequest attribute that the adaptor will store the current ChannelRuntimeData under.
static String	CHANNEL_PARAM__IS_FRAMEWORK_PORTLET Deprecated. Name of the org.jasig.portal.ChannelDefinition parameter used to determine if the portlet application ID should be set to the context path of the portal.
static String	CHANNEL_PARAM__PORTLET_APPLICATION_ID Deprecated. Name of the org.jasig.portal.ChannelDefinition parameter the name of the PortletAppDD is defined in.
static String	CHANNEL_PARAM__PORTLET_NAME Deprecated. Name of the org.jasig.portal.ChannelDefinition parameter the name of the PortletDD is defined in.
static PortletMode	CONFIG Deprecated.
static WindowState	DETACHED Deprecated.
static WindowState	EXCLUSIVE Deprecated.
static String	MULTIVALUED_USERINFO_MAP_ATTRIBUTE Deprecated. Name of the HttpServletRequest attribute that the adaptor will store a Map of user info attributes that has support for multi-valued attributes.

Fields inherited from interface org.jasig.portal.ICacheable

CHANNEL_CACHE_KEY_INSTANCE_SCOPE, CHANNEL_CACHE_KEY_SCOPE_PARAM_NAME, CHANNEL_CACHE_KEY_SYSTEM_SCOPE

Method Summary

void	processAction() Deprecated. IChannel.setStaticData(org.jasig.portal.ChannelStaticData), IPrivileged.setPortalControlStructures(org.jasig.portal.PortalControlStructures), and IChannel.setRuntimeData(org.jasig.portal.ChannelRuntimeData) will be called before this method.

Methods inherited from interface org.jasig.portal.IResetableChannel

prepareForRefresh, prepareForReset

Methods inherited from interface org.jasig.portal.IPrivileged

setPortalControlStructures

Methods inherited from interface org.jasig.portal.ICharacterChannel

renderCharacters

Methods inherited from interface org.jasig.portal.IChannel

getRuntimeProperties, receiveEvent, renderXML, setRuntimeData, setStaticData

Methods inherited from interface org.jasig.portal.ICacheable

generateKey, isCacheValid

Methods inherited from interface org.jasig.portal.IDirectResponse

setResponse

Field Detail

EXCLUSIVE

static final WindowState EXCLUSIVE

Deprecated.

DETACHED

static final WindowState DETACHED

Deprecated.

ABOUT

static final PortletMode ABOUT

Deprecated.

CONFIG

static final PortletMode CONFIG

Deprecated.

ATTRIBUTE__RUNTIME_DATA

static final String ATTRIBUTE__RUNTIME_DATA

Deprecated.

HttpServletRequest attribute that the adaptor will store the current ChannelRuntimeData under.

ATTRIBUTE__PORTLET_TITLE

static final String ATTRIBUTE__PORTLET_TITLE

Deprecated.

HttpServletRequest attribute that the adaptor will store the title the portlet dynamically sets under.

CHANNEL_PARAM__PORTLET_APPLICATION_ID

static final String CHANNEL_PARAM__PORTLET_APPLICATION_ID

Deprecated.

Name of the org.jasig.portal.ChannelDefinition parameter the name of the PortletAppDD is defined in.

See Also:

PortletRegistryService.getPortletApplicationDescriptor(String), Constant Field Values

CHANNEL_PARAM__PORTLET_NAME

static final String CHANNEL_PARAM__PORTLET_NAME

Deprecated.

Name of the org.jasig.portal.ChannelDefinition parameter the name of the PortletDD is defined in.

See Also:

PortletAppDD.getPortlets(), Constant Field Values

CHANNEL_PARAM__IS_FRAMEWORK_PORTLET

static final String CHANNEL_PARAM__IS_FRAMEWORK_PORTLET

Deprecated.

Name of the org.jasig.portal.ChannelDefinition parameter used to determine if the portlet application ID should be set to the context path of the portal.

See Also:

Constant Field Values

MULTIVALUED_USERINFO_MAP_ATTRIBUTE

static final String MULTIVALUED_USERINFO_MAP_ATTRIBUTE

Deprecated.

Name of the HttpServletRequest attribute that the adaptor will store a Map of user info attributes that has support for multi-valued attributes.

See Also:

Constant Field Values

Method Detail

processAction

void processAction()
                   throws PortalException

Deprecated.

IChannel.setStaticData(org.jasig.portal.ChannelStaticData), IPrivileged.setPortalControlStructures(org.jasig.portal.PortalControlStructures), and IChannel.setRuntimeData(org.jasig.portal.ChannelRuntimeData) will be called before this method. Actions are executed before the layout rendering pipeline is initiated and redirects can be sent though content can not be written out to the response. Only one channel will execute a processAction per request.

Throws:

PortalException - If an exception occurs while processing the action.