org.jasig.portal.channels.adminnav
Class AdminNavChannel

java.lang.Object
  org.jasig.portal.channels.BaseChannel
      org.jasig.portal.channels.adminnav.AdminNavChannel

All Implemented Interfaces:

ICacheable, IChannel

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class AdminNavChannel
extends BaseChannel
implements ICacheable

This channel is a wrapper around an implementation that provides urls (links) to other channels. Typically, this is by functional name so that when selected those channels are rendered in focus mode. Links are added dynamically by calling the addLink() method which is delegated to the plugged-in implementation. CHeader channel presents the "Channel Admin" link which brings this channel into focused mode when selected. CHeader delegates to canAccess() to determine if there is any content within this channel that is accessible to the current user. If so then it will render the ChannelAdmin link. Similarly, when the implementation renders it should only present 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. A channel can provide links to this channel by calling their ChannelRuntimeData.getFnameActionURL() passing the functional name of this channel "admin_navigation_links".

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

AdminNavChannel()
Deprecated.

Method Summary

static boolean	canAccess(IAuthorizationPrincipal ap) Deprecated. Delegates to the plugged-in model to answer if the user represented by the passed-in authorization principal has access to this channel.
ChannelCacheKey	generateKey() Deprecated. Delegates to the plugged-in implementation to generate a key as part of its implementation of the ICacheable interface.
static ILinkRegistrar	getLinkRegistrar() Deprecated. Returns an object that can be used to add links at runtime to the underlying administrative navigational links model.
boolean	isCacheValid(Object validity) Deprecated. Delegates to the plugged-in implementation to determine using the passed-in validity object if cached output can be reused as part of its implementation of the ICacheable interface.
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 the passed-in channel static configuration information to the plugged-in model.

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

Constructor Detail

AdminNavChannel

public AdminNavChannel()

Deprecated.

Method Detail

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

canAccess

public static boolean canAccess(IAuthorizationPrincipal ap)

Deprecated.

Delegates to the plugged-in model to answer if the user represented by the passed-in authorization principal has access to this channel. If any of the information available in the implementation should be accessible to the user then the model should return true.

getLinkRegistrar

public static ILinkRegistrar getLinkRegistrar()

Deprecated.

Returns an object that can be used to add links at runtime to the underlying administrative navigational links model.

generateKey

public ChannelCacheKey generateKey()

Deprecated.

Delegates to the plugged-in implementation to generate a key as part of its implementation of the ICacheable interface.

Specified by:

generateKey in interface ICacheable

See Also:

ICacheable.generateKey()

isCacheValid

public boolean isCacheValid(Object validity)

Deprecated.

Delegates to the plugged-in implementation to determine using the passed-in validity object if cached output can be reused as part of its implementation of the ICacheable interface.

Specified by:

isCacheValid in interface ICacheable

See Also:

ICacheable.isCacheValid(java.lang.Object)

setStaticData

public void setStaticData(ChannelStaticData sd)
                   throws PortalException

Deprecated.

Passes the passed-in channel static configuration information to the plugged-in model.

Specified by:

setStaticData in interface IChannel

Overrides:

setStaticData in class BaseChannel

Parameters:

sd - channel static data

Throws:

PortalException

See Also:

ChannelStaticData