org.apache.pluto.om.servlet
Interface ServletDefinition

All Superinterfaces:
Model

public interface ServletDefinition
extends Model

This interface provides access to a servlet and its attributes. A servlet is defined in the web.xml of a portlet application archive file. Portlet information defined in the portlet.xml is also accessible in this interface when the information is bound to the application code.
Additionaly, this interface allows to retrieve all containing elements such as content types.

This interface defines the model as known from the MVC pattern. Its purpose is to provide read access to the data stored in the model.


Method Summary
 long getAvailable()
          Returns the available date/time for this servlet, in milliseconds since the epoch.
 Description getDescription(java.util.Locale locale)
          Returns the description for the given locale The return value may be NULL.
 DisplayName getDisplayName(java.util.Locale locale)
          Returns the display name for the given locale of this servlet.
 ObjectID getId()
          Returns the identifier of this servlet The return value cannot be NULL.
 ParameterSet getInitParameterSet()
          Returns all parameters of this portlet The return value cannot be NULL.
 javax.servlet.RequestDispatcher getRequestDispatcher(javax.servlet.ServletContext servletContext)
          Returns the request dispatcher pointing to this servlet
 java.lang.String getServletClass()
          Returns the class name of this servlet The return value may be NULL.
 java.lang.String getServletName()
          Returns the servlet name The return value cannot be NULL.
 WebApplicationDefinition getWebApplicationDefinition()
          Returns the WebApplication object in which this servlet resides The return value cannot be NULL.
 boolean isUnavailable()
          Returns if this servlet is currently unavailable.
 

Method Detail

getId

public ObjectID getId()
Returns the identifier of this servlet The return value cannot be NULL.

Returns:
the identifier

getServletName

public java.lang.String getServletName()
Returns the servlet name The return value cannot be NULL.

Returns:
the servlet name

getDisplayName

public DisplayName getDisplayName(java.util.Locale locale)
Returns the display name for the given locale of this servlet. The return value may be NULL.

Returns:
the localized display name

getDescription

public Description getDescription(java.util.Locale locale)
Returns the description for the given locale The return value may be NULL.

Returns:
the description

getServletClass

public java.lang.String getServletClass()
Returns the class name of this servlet The return value may be NULL.

Returns:
the class name

getInitParameterSet

public ParameterSet getInitParameterSet()
Returns all parameters of this portlet The return value cannot be NULL.

Returns:
the parameter set

getWebApplicationDefinition

public WebApplicationDefinition getWebApplicationDefinition()
Returns the WebApplication object in which this servlet resides The return value cannot be NULL.

Returns:
the WebApplication object of this servlet

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(javax.servlet.ServletContext servletContext)
Returns the request dispatcher pointing to this servlet

Parameters:
servletContext - a servlet context
Returns:
the request dispatcher of this portlet

getAvailable

public long getAvailable()
Returns the available date/time for this servlet, in milliseconds since the epoch. If this date/time is in the future the servlet is unavailable. If it is zero, the servlet is currently available. A value equal to Long.MAX_VALUE is considered to mean that unavailability is permanent.

Returns:
the available date/time for this servlet

isUnavailable

public boolean isUnavailable()
Returns if this servlet is currently unavailable.

Returns:
true if this servlet is unavailable


Copyright © 2003-2007 . All Rights Reserved.