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.
Modifier and Type | Method and Description |
---|---|
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.
|
ObjectID getId()
java.lang.String getServletName()
DisplayName getDisplayName(java.util.Locale locale)
Description getDescription(java.util.Locale locale)
java.lang.String getServletClass()
ParameterSet getInitParameterSet()
WebApplicationDefinition getWebApplicationDefinition()
javax.servlet.RequestDispatcher getRequestDispatcher(javax.servlet.ServletContext servletContext)
servletContext
- a servlet contextlong getAvailable()
boolean isUnavailable()
true
if this servlet is unavailableCopyright © 2003-2013 . All Rights Reserved.