com.ibm.as400.webaccess.util
Class ServletDescriptor

java.lang.Object
  |
  +--com.ibm.as400.webaccess.util.ServletDescriptor

public final class ServletDescriptor
extends java.lang.Object

Represents a documented WebAccess servlet URI, and its associated properties.


Field Summary
static int CATEGORY_5250
           
static int CATEGORY_COMMAND
           
static int CATEGORY_CUSTOMIZE
           
static int CATEGORY_DATABASE
           
static int CATEGORY_DOWNLOAD
           
static int CATEGORY_FILES
           
static int CATEGORY_JOBS
           
static int CATEGORY_MESSAGES
           
static int CATEGORY_OTHER
           
static int CATEGORY_PRINT
           
 
Constructor Summary
ServletDescriptor(int category, java.lang.String uri, boolean isListServlet, ServletParameter[] parms, java.lang.String titleKey, java.lang.String descriptionKey)
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
static int[] getCategories()
          Returns an array of all known servlet categories.
 int getCategory()
          Returns the category to which this servlet belongs.
static java.lang.String getCategoryDescription(int category, java.util.ResourceBundle bundle)
          Returns the translated description of the specified category.
static java.lang.String getCategoryTitle(int category, java.util.ResourceBundle bundle)
          Returns the translated title name of the specified category.
static ServletParameter[] getCommonParameters()
          Returns the array of common servlet parameters.
 java.lang.String getDescription(java.util.ResourceBundle bundle)
          Returns the translated description of this servlet.
 ServletParameter[] getOptionalParameters()
          Returns the array of optional parameters for this servlet, or an empty array if there are none.
 ServletParameter getParameter(java.lang.String uri)
          Returns the servlet parameter for the given URI, or null if no match was found.
 ServletParameter[] getParameters()
          Returns the array of parameters for this servlet, or an empty array if there are none.
 ServletParameter[] getRequiredParameters()
          Returns the array of required parameters for this servlet, or an empty array if there are none.
 java.lang.String getTitle(java.util.ResourceBundle bundle)
          Returns the translated title name of this servlet.
 java.lang.String getTitleKey()
          Returns the translated title MRI key of this servlet.
 java.lang.String getURI()
          Returns the URI string for this servlet, e.g.
 boolean isListServlet()
          Indicates if this servlet is a WebAccess list servlet or not.
 boolean supportsCommonParms()
          Indicates if this servlet supports the common parameters.
 void supportsCommonParms(boolean supportsCommonParms)
          Sets whether this servlet supports the common parameters.
 boolean supportsIFramePortlet()
          Indicates if this servlet supports being configured by the IFrame portlet.
 void supportsIFramePortlet(boolean supportsIFramePortlet)
          Sets whether this servlet supports being configured by the IFrame portlet.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CATEGORY_5250

public static final int CATEGORY_5250
See Also:
Constant Field Values

CATEGORY_COMMAND

public static final int CATEGORY_COMMAND
See Also:
Constant Field Values

CATEGORY_CUSTOMIZE

public static final int CATEGORY_CUSTOMIZE
See Also:
Constant Field Values

CATEGORY_DATABASE

public static final int CATEGORY_DATABASE
See Also:
Constant Field Values

CATEGORY_DOWNLOAD

public static final int CATEGORY_DOWNLOAD
See Also:
Constant Field Values

CATEGORY_FILES

public static final int CATEGORY_FILES
See Also:
Constant Field Values

CATEGORY_JOBS

public static final int CATEGORY_JOBS
See Also:
Constant Field Values

CATEGORY_MESSAGES

public static final int CATEGORY_MESSAGES
See Also:
Constant Field Values

CATEGORY_PRINT

public static final int CATEGORY_PRINT
See Also:
Constant Field Values

CATEGORY_OTHER

public static final int CATEGORY_OTHER
See Also:
Constant Field Values
Constructor Detail

ServletDescriptor

public ServletDescriptor(int category,
                         java.lang.String uri,
                         boolean isListServlet,
                         ServletParameter[] parms,
                         java.lang.String titleKey,
                         java.lang.String descriptionKey)
Method Detail

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

getCategories

public static int[] getCategories()
Returns an array of all known servlet categories.


getCategory

public int getCategory()
Returns the category to which this servlet belongs.


getCategoryDescription

public static java.lang.String getCategoryDescription(int category,
                                                      java.util.ResourceBundle bundle)
Returns the translated description of the specified category.


getCategoryTitle

public static java.lang.String getCategoryTitle(int category,
                                                java.util.ResourceBundle bundle)
Returns the translated title name of the specified category.


getCommonParameters

public static ServletParameter[] getCommonParameters()
Returns the array of common servlet parameters.


getDescription

public java.lang.String getDescription(java.util.ResourceBundle bundle)
Returns the translated description of this servlet.


getParameter

public ServletParameter getParameter(java.lang.String uri)
Returns the servlet parameter for the given URI, or null if no match was found.


getParameters

public ServletParameter[] getParameters()
Returns the array of parameters for this servlet, or an empty array if there are none.


getRequiredParameters

public ServletParameter[] getRequiredParameters()
Returns the array of required parameters for this servlet, or an empty array if there are none.


getOptionalParameters

public ServletParameter[] getOptionalParameters()
Returns the array of optional parameters for this servlet, or an empty array if there are none.


getTitle

public java.lang.String getTitle(java.util.ResourceBundle bundle)
Returns the translated title name of this servlet.


getTitleKey

public java.lang.String getTitleKey()
Returns the translated title MRI key of this servlet.


getURI

public java.lang.String getURI()
Returns the URI string for this servlet, e.g. "iWAMain".


isListServlet

public boolean isListServlet()
Indicates if this servlet is a WebAccess list servlet or not. List servlets always have a page parameter.


supportsCommonParms

public boolean supportsCommonParms()
Indicates if this servlet supports the common parameters.


supportsCommonParms

public void supportsCommonParms(boolean supportsCommonParms)
Sets whether this servlet supports the common parameters.


supportsIFramePortlet

public boolean supportsIFramePortlet()
Indicates if this servlet supports being configured by the IFrame portlet.


supportsIFramePortlet

public void supportsIFramePortlet(boolean supportsIFramePortlet)
Sets whether this servlet supports being configured by the IFrame portlet.