org.jasig.portal.channels.adminnav.provider
Class ListModel

java.lang.Object
  org.jasig.portal.channels.BaseChannel
      org.jasig.portal.channels.adminnav.provider.ListModel

All Implemented Interfaces:

ILinkRegistrar, INavigationModel, ICacheable, IChannel

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class ListModel
extends BaseChannel
implements INavigationModel

This channel provides a flat list of urls (links) to other channels using the channel functional names. When selected these links cause that channel to be rendered in focused mode. This implementation supports both static and dynamic registration. Dynamic registration takes place any time via calls to addLink(). The set of static links is defined in /properties/adminNav.xml. Their locale specific text is loaded from /properties/adminNav.properties or a suitable derivative for a specific locale. CHeader channel presents the "Channel Admin" link which brings this channel into focused mode when selected. That link will only render if this channel has registered links that point to channels for which the current user has authorization. Similarly, when this channel renders, it only presents those links to channels for which the current user has authorization. Localization of link labels is supported through instances of ILabelResolver passed in at link registration time.

Author:

Keith Stacks, kstacks@sungardsct.com, Mark Boyd, mboyd@sungardsct.com

Field Summary

Fields inherited from class org.jasig.portal.channels.BaseChannel

log, runtimeData, staticData

Fields inherited from interface org.jasig.portal.ICacheable

CHANNEL_CACHE_KEY_INSTANCE_SCOPE, CHANNEL_CACHE_KEY_SCOPE_PARAM_NAME, CHANNEL_CACHE_KEY_SYSTEM_SCOPE

Constructor Summary

ListModel()
Deprecated.

Method Summary

void	addLink(String fname, String labelId, ILabelResolver resolver, Map parameters) Deprecated. Add a link to the channel indicated by the passed in functional name to the list of links located in the admin navigation list.
boolean	canAccess(IAuthorizationPrincipal ap) Deprecated. Returns true if the user represented by the passed-in authorization principal returns has access to any of the channels pointed to by registered links.
ChannelCacheKey	generateKey() Deprecated. Return the reused cache key.
boolean	isCacheValid(Object validity) Deprecated. The validity object used in our cache key is the locale used to generate the XML for the channel.
void	renderXML(ContentHandler out) Deprecated. Render the links.
void	setRuntimeData(ChannelRuntimeData rd) Deprecated. Checks to see if the rendering document needs to be updated for the user's locale.
void	setStaticData(ChannelStaticData sd) Deprecated. Passes ChannelStaticData to the channel.

Methods inherited from class org.jasig.portal.channels.BaseChannel

getRuntimeProperties, receiveEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jasig.portal.IChannel

getRuntimeProperties, receiveEvent

Constructor Detail

ListModel

public ListModel()

Deprecated.

Method Detail

canAccess

public boolean canAccess(IAuthorizationPrincipal ap)

Deprecated.

Returns true if the user represented by the passed-in authorization principal returns has access to any of the channels pointed to by registered links. This is used by CHeader to determine if the "Channel Admin" link should be rendered.

Specified by:

canAccess in interface INavigationModel

Returns:

boolean

addLink

public void addLink(String fname,
                    String labelId,
                    ILabelResolver resolver,
                    Map parameters)

Deprecated.

Add a link to the channel indicated by the passed in functional name to the list of links located in the admin navigation list. The label will be the text shown in the UI for the link. The name/value pairs passed in via the parameters argument will be appended as query parameters.

Specified by:

addLink in interface ILinkRegistrar

Parameters:

fname - the functional name of a published channel. This must not be null and must correspond to the functional name of an already published channel.

labelId - the test that should show in the UI for this link. This must not be null.

parameters - additional query parameter name/value pairs to be appended to the URL if needed for the link. This value can be null if no additional parameters are needed.

generateKey

public ChannelCacheKey generateKey()

Deprecated.

Return the reused cache key. Only the internal validity is used and handed back via isCacheValid().

Specified by:

generateKey in interface ICacheable

isCacheValid

public boolean isCacheValid(Object validity)

Deprecated.

The validity object used in our cache key is the locale used to generate the XML for the channel. So cache refresh will only take place when the user changes their locale.

Specified by:

isCacheValid in interface ICacheable

setStaticData

public void setStaticData(ChannelStaticData sd)
                   throws PortalException

Deprecated.

Description copied from interface: IChannel

Passes ChannelStaticData to the channel. This is done during channel instantiation time. see org.jasig.portal.ChannelStaticData

Specified by:

setStaticData in interface IChannel

Overrides:

setStaticData in class BaseChannel

Parameters:

sd - channel static data

Throws:

PortalException

See Also:

ChannelStaticData

setRuntimeData

public void setRuntimeData(ChannelRuntimeData rd)
                    throws PortalException

Deprecated.

Checks to see if the rendering document needs to be updated for the user's locale.

Specified by:

setRuntimeData in interface IChannel

Overrides:

setRuntimeData in class BaseChannel

Parameters:

rd - channel runtime data

Throws:

PortalException

See Also:

ChannelRuntimeData

renderXML

public void renderXML(ContentHandler out)
               throws PortalException

Deprecated.

Render the links.

Specified by:

renderXML in interface IChannel

Overrides:

renderXML in class BaseChannel

Parameters:

out - stream that handles output

Throws:

PortalException