|
Portlet API (V1.0) | |||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||
ActionRequest represents the request sent to the portlet
to handle an action.ActionResponse interface represents the portlet
response to an action request.PORTLET_SCOPE.
edit mode.
help mode.
view mode.
EDIT portlet mode, a portlet should provide
content and logic that lets a user customize the behavior of the portlet.
setProperty method.
GenericPortlet class provides a default implementation
for the Portlet interface.Object,
or null if no attribute of the given name exists.
PORTLET_SCOPE, or null if no
object is bound under the name in that scope.
null if no object is bound under the name in the given scope.
Enumeration containing the
names of the attributes available to this request.
Enumeration of String objects containing the names of
all the objects bound to this session under the PORTLET_SCOPE, or an
empty Enumeration if no attributes are available.
Enumeration containing the attribute names
available within this portlet context, or an emtpy
Enumeration if no attributes are available.
Enumeration of String objects containing the names of
all the objects bound to this session in the given scope, or an
empty Enumeration if no attributes are available in the
given scope.
BASIC_AUTH, CLIENT_CERT_AUTH,
a custom one or null if there was no authentication.
null if the
cause is nonexistent or unknown.
null if the parameter does not exist.
Enumeration of String objects, or an empty Enumeration if the
portlet has no initialization parameters.
Enumeration of String objects, or an empty Enumeration if the context
has no initialization parameters.
Map of the preferences.
null if
the MIME type is not known.
PortletRequestDispatcher object that acts
as a wrapper for the named servlet.
Enumeration if no keys are
available.
String,
or null if the parameter does not exist.
Map of the parameters of this request.
Enumeration of String
objects containing the names of the parameters contained
in this request.
String objects containing
all of the values the given request parameter has, or
null if the parameter does not exist.
PortletContext of the portlet application
the portlet is in.
PortletContext of the portlet application
the portlet is in.
web.xml deployment descriptor for this web application by the
display-name element.
InputStream.
OutputStream suitable for writing binary
data in the response.
true, creates one and returns
the new session.
Enumeration of String objects.
String.
null if there is
no property by that name.
Enumeration of all the property names
this request contains.
Enumeration if there are no property names.
BufferedReader.
String containing the real path
for a given virtual path.
PortletRequestDispatcher object that acts
as a wrapper for the resource located at the given path.
resource-bundle tag or the inlined resources
defined in the deployment descriptor.
resource-bundle tag or the inlined resources
defined in the deployment descriptor.
PorltetMode objects.
WindowState objects.
HELP portlet mode, a portlet should provide help
information about the portlet.
super.init(config).
boolean indicating
whether the portlet is permanently unavailable.
MAXIMIZED window state is an indication
that a portlet may be the only portlet being rendered in the
portal page, or that the portlet has more space compared to other portlets
in the portal page.
MINIMIZED window state,
the portlet should only render minimal output or no output at all.
NORMAL window state indicates that a portlet
may be sharing the page with other portlets.
PortalContext interface gives the portlet
the ability to retrieve information about the portal calling this portlet.Portlet interface is used by the portlet container to
invoke the portlets.PortletConfig interface provides the portlet with
its configuration.PortletContext interface defines a portlet view
of the portlet container.PortletException class defines a general exception
that a portlet can throw when it is unable to perform its operation
successfully.PortletMode class represents
the possible modes that a portlet can assume.PortletModeException is thrown when a portlet
tries to use or set a portlet mode that is not supported by the current
runtime environment or the portlet.PortletPreferences interface allows the portlet to store
configuration data.PortletRequest defines the base interface to provide client
request information to a portlet.PortletRequestDispatcher interface
defines an object that receives requests from the client
and sends them to the specified resources (such as a servlet,
HTML file, or JSP file) on the server.PortletResponse defines the base interface to assist a
portlet in creating and sending a response to the client.PortletSecurityException
when a call fails because of security reasons.PortletSession interface provides a way to identify a user
across more than one request and to store transient information about that user.PortletSessionUtil class helps identify and decode
attributes in the PORTLET_SCOPE scope of the PortletSession
when accessed through the HttpSession an from within calls to methods
of the HttpSessionBindingListener interface.PortletURL interface represents a URL
that reference the portlet itself.PreferencesValidator allows to validate the set of
preferences of the associated portlet just before they are
stored in the persistent store.ReadOnlyException is thrown when a portlet tries
to change the value for a read-only preference attribute.PORTLET_SCOPE from
this session.
getTitle method and invokes the
doDispatch method.
RenderRequest represents the request sent to the portlet
to handle a render.RenderResponse defines an object to assist a portlet in
sending a response to the portal.PORTLET_SCOPE, using the name specified.
set methods in the persistent store.
UnavailableException when
the portlet is either temporarily or permanently unavailable to handle requests.getAttribute call.
ValidatorException is thrown by the
validate method of a PreferencesValidator when
the validation of a preference failed.VIEW portlet mode
is to generate markup reflecting the current state of the portlet.
WindowState class represents
the possible window states that a portlet window can assume.WindowStateException is thrown when a portlet
tries to use a window state that is not supported by the current
runtime environment or the portlet.
|
Portlet API (V1.0) | |||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||