live.constants
Class Attributes

java.lang.Object
  extended bylive.constants.Attributes

public final class Attributes
extends Object

The Attributes class holds String constants that are mostly used (with exceptions as below) by the JSP pages to display information. The organization is as follows. There are a number of nested classes in this that correspond to directories in the file system or files. For instance, the class Attributes.networks.listholds attributes that are used by the JSP page networks/list.jsp. If you were going to forward to that page, you must set the attribute networks.list.vswitches (networks.list.glans too if the tool supported guest LANs) before forwarding. Any attributes ending with _OPT are optional, and if omitted the JSP page will display without error. (TODO: Unfortunately, this won't tell you what type of object is expected or anything like that. What would be nice is if you could make a full-fledged object for each page with a number of setAttribute methods that would be typed. e.g., there would be a method setVSwitchList(LinkedList) in the networks.list class. Then there would be a forward() method that would return an ActionForward to that page.) The two classes Attributes.guestList, and Attributes.Globalalso correspond this way, but are used slightly differently. Global holds attributes that are common to all pages, but no Global.jsp exists. (TODO: Ideally then, all pages would inherit from Global.) guestList holds attributes that are used by guestList.jsp. However, this page is never actually loaded expliticly, only included in other pages. Thus rather than refer to the constants in guestList itself, you should make pages that include it extend guestList and refer to the then-inherited attributes in that class. (See Attributes.networks.newPage for an example.) The remaining two class are Attributes.servletContextand Attributes.session. servletContext holds attributes where actions can retrieve stuff like the current cache object and the cacheThread. session is where actions can retrieve session-specific attributes such as the thread info object.

Author:
Evan Driscoll

Nested Class Summary
static class Attributes.confirmation
          Attributes expected by the confirmation page
static class Attributes.error
          Request attributes expected by the error page
static class Attributes.Global
          Holds attributes common to all pages.
static class Attributes.guestList
          Holds attribute names expected by the guestList.
static class Attributes.guests
          Pages relating to guests and groups
static class Attributes.login
          This is an attribute expected by the logon ACTION
static class Attributes.networks
          Network pages
static class Attributes.servletContext
          Holds attribute names containing information that should be shared across sessions.
static class Attributes.session
          Holds attribute names containing information that should be shared across requests, but not across sessions.
static class Attributes.sharedSegmentsList
          Attributes for shared segments list page.
static class Attributes.sharedSegmentsNew
          Attributes for shared segments new page.
static class Attributes.status
          Attributes expected by the status pages.
 
Constructor Summary
Attributes()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Attributes

public Attributes()


Copyright © 2005