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 author: Mark Boyd, mboyd@sungardsct.com
addLink(String fname, String labelId, ILabelResolver resolver, Map parameters) Add a link to the channel indicated by the passed in functional name to
the list of links located in the admin navigation list.
public boolean
canAccess(IAuthorizationPrincipal ap) 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.
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.
Parameters: fname - the functional name of a published channel. This must not benull and must correspond to the functional name of an alreadypublished channel. Parameters: labelId - the test that should show in the UI for this link. This mustnot be null. Parameters: parameters - additional query parameter name/value pairs to be appended tothe URL if needed for the link. This value can be null if noadditional parameters are needed.
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.
Return the reused cache key. Only the internal validity is used and
handed back via isCacheValid().
isCacheValid
public boolean isCacheValid(Object validity)(Code)
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.
