org.jaffa.components.navigation
Class NavAccessor

java.lang.Object
  org.jaffa.components.navigation.NavAccessor

public class NavAccessor

extends Object

This class allows access to a navigation system, based on a users access. When this object is constructed, it looks at the full navigation system, and filters out any options the current user does not have access to.

Version:

1.0

Author:

JonnyR, PaulE

Method Summary

void	clearSession(HttpSession session) Clear the NavAccessor attribute for this session.
NavOption	getDesktopNavOptions(String desktopId) Based on the DesktopId passed a list will be build of child nodes based on security and parent node ID.
List	getGlobalNavOptions() Based on the UserId this method will return the list of variables available to the user.
static NavAccessor	getNavAccessor(HttpSession session) This is a static method to allow a synchronized Access to the NavAccessor object caching it on creation
static void	main(String[] args)
static void	printMenuOptions(List l, String prefix)

Methods inherited from class java.lang.Object

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

Method Detail

getNavAccessor

public static NavAccessor getNavAccessor(HttpSession session)

This is a static method to allow a synchronized Access to the NavAccessor object caching it on creation

getGlobalNavOptions

public List getGlobalNavOptions()

Based on the UserId this method will return the list of variables available to the user.

Returns:

This returns a List of every menu NavOption available to the user based on their UserId

getDesktopNavOptions

public NavOption getDesktopNavOptions(String desktopId)

Based on the DesktopId passed a list will be build of child nodes based on security and parent node ID.

Parameters:

desktopId - Desktop Id that will one verified be used to return a list of NavOptions that are children that have this desktop Id

Returns:

List of NavOptions based on a DektopId is passed back , for use in building desktop navs

clearSession

public void clearSession(HttpSession session)

Clear the NavAccessor attribute for this session.

main

public static void main(String[] args)

printMenuOptions

public static void printMenuOptions(List l,
                                    String prefix)