|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
@ProcessAction annotation.
javax.portlet.actionScopedRequestAttributes
container runtime option is used by the portlet.
ActionFilter is an object that performs filtering
tasks on either the action request to a portlet, or on the action response from
a portlet, or both.ActionRequest represents the request sent to the portlet
to handle an action.ActionRequestWrapper provides a convenient
implementation of the ActionRequest interface
that can be subclassed by developers wishing to adapt the request.ActionRequest adaptor
wrapping the given request object.
ActionResponse interface represents the portlet
response to an action request.ActionResponseWrapper provides a convenient
implementation of the ActionResponse interface
that can be subclassed by developers wishing to adapt the response.ActionResponse adaptor
wrapping the given response object.
addProperty(key, value) on the wrapped response object.
addProperty() on the wrapped response object.
addProperty() on the wrapped response object.
BaseURL defines the basic capabilities
of a portlet URL pointing back to the portlet.setProperty method intended to be used in
forwarded or included servlets/JSPs.
CacheControl interface represents cache settings
for a piece of markup.javax.ccpp.Profile
with the getAttribute call.
ClientDataRequest represents the request information
of the HTTP request issued from the client to the portal.createActionURL() on the wrapped response object.
createActionURL() on the wrapped response object.
createElement() on the wrapped response object.
PortletResponse.addProperty(String,Element) method.
createRenderURL() on the wrapped response object.
createRenderURL() on the wrapped response object.
createResourceURL() on the wrapped response object.
createResourceURL() on the wrapped response object.
PORTLET_SCOPE.
@RenderMode and the name of the
portlet mode
a set of helper methods depending on the current portlet mode the portlet
is currently in.
- doEdit(RenderRequest, RenderResponse) -
Method in class javax.portlet.GenericPortlet
- Helper method to serve up the
edit mode.
- doFilter(ActionRequest, ActionResponse, FilterChain) -
Method in interface javax.portlet.filter.ActionFilter
- The
doFilter method of the Filter is called by the
portlet container each time a action request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain.
- doFilter(EventRequest, EventResponse, FilterChain) -
Method in interface javax.portlet.filter.EventFilter
- The
doFilter method of the Filter is called by the
portlet container each time a event request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain.
- doFilter(ActionRequest, ActionResponse) -
Method in interface javax.portlet.filter.FilterChain
- Causes the next filter in the chain to be invoked,
or if the calling filter is the last filter in the chain,
causes the portlet at the end of the chain to be invoked.
- doFilter(EventRequest, EventResponse) -
Method in interface javax.portlet.filter.FilterChain
- Causes the next filter in the chain to be invoked,
or if the calling filter is the last filter in the chain,
causes the portlet at the end of the chain to be invoked.
- doFilter(RenderRequest, RenderResponse) -
Method in interface javax.portlet.filter.FilterChain
- Causes the next filter in the chain to be invoked,
or if the calling filter is the last filter in the chain,
causes the portlet at the end of the chain to be invoked.
- doFilter(ResourceRequest, ResourceResponse) -
Method in interface javax.portlet.filter.FilterChain
- Causes the next filter in the chain to be invoked,
or if the calling filter is the last filter in the chain,
causes the portlet at the end of the chain to be invoked.
- doFilter(RenderRequest, RenderResponse, FilterChain) -
Method in interface javax.portlet.filter.RenderFilter
- The
doFilter method of the Filter is called by the
portlet container each time a render request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain.
- doFilter(ResourceRequest, ResourceResponse, FilterChain) -
Method in interface javax.portlet.filter.ResourceFilter
- The
doFilter method of the Filter is called by the
portlet container each time a resource request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain.
- doHeaders(RenderRequest, RenderResponse) -
Method in class javax.portlet.GenericPortlet
- Used by the render method to set the response properties and headers.
- doHelp(RenderRequest, RenderResponse) -
Method in class javax.portlet.GenericPortlet
- Helper method to serve up the
help mode.
- doView(RenderRequest, RenderResponse) -
Method in class javax.portlet.GenericPortlet
- Helper method to serve up the mandatory
view mode.
EDIT portlet mode, a portlet should provide
content and logic that lets a user customize the behavior of the portlet.
encodeURL(path) on the wrapped response object.
Event interface represents an event that the portlet has received
in the event processing phase.EventFilter is an object that performs filtering
tasks on either the event request to a portlet, or on the event response from
a portlet, or both.EventPortlet interface allows
portlets receiving events.EventRequest represents the request sent to the portlet
to handle an event.EventRequestWrapper provides a convenient
implementation of the EventRequest interface
that can be subclassed by developers wishing to adapt the request.EventRequest adaptor
wrapping the given request object.
EventResponse interface represents the portlet
response to an event request.EventResponseWrapper provides a convenient
implementation of the EventResponse interface
that can be subclassed by developers wishing to adapt the response.EventResponse adaptor
wrapping the given response object.
setProperty method intended to be used in
forwarded or included servlets/JSPs.
toString or write
are executed on action URLs.
FilterChain is an object provided by the portlet container
to the developer giving a view into the invocation chain of a
filtered request for a portlet.toString or write
are executed on render URLs.
toString or write
are executed on resource URLs.
flushBuffer() on the wrapped response object.
flushBuffer() on the wrapped response object.
FULL does not need to contain the current
state of the page or the current render parameters, portlet mode, or
window state of the portlet.
GenericPortlet class provides a default implementation for
the Portlet interface.getAttribute(String name) on the wrapped request object.
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.
Map of the session attributes in
the portlet session scope.
Map of the session attributes in
the given session scope.
getAttributeNames() on the wrapped request object.
Enumeration containing the attribute names
available within this portlet context, or an empty
Enumeration if no attributes are available.
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 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.
getAuthType() on the wrapped request object.
BASIC_AUTH, CLIENT_CERT_AUTH,
a custom one or null if there was no authentication.
getBufferSize() on the wrapped response object.
getBufferSize() on the wrapped response object.
getCacheability() on the wrapped response object.
getCacheControl() on the wrapped response object.
getCacheControl() on the wrapped response object.
getCharacterEncoding() on the wrapped request object.
getCharacterEncoding() on the wrapped response object.
getCharacterEncoding() on the wrapped request object.
getCharacterEncoding() on the wrapped response object.
getContentLength() on the wrapped request object.
getContentLength() on the wrapped request object.
getContentType() on the wrapped request object.
getContentType() on the wrapped response object.
getContentType() on the wrapped request object.
getContentType() on the wrapped response object.
getContextPath() on the wrapped request object.
getCookies() on the wrapped request object.
null
if no ETag is set on the response.
- getETag() -
Method in class javax.portlet.filter.RenderRequestWrapper
- The default behavior of this method is to call
getETag() on the wrapped request object.
- getETag() -
Method in class javax.portlet.filter.ResourceRequestWrapper
- The default behavior of this method is to call
getETag() on the wrapped request object.
- getETag() -
Method in interface javax.portlet.RenderRequest
- Returns the validation tag if the portlet container
has a cached response for this validation tag, or
null if no cached response exists.
- getETag() -
Method in interface javax.portlet.ResourceRequest
- Returns the validation tag if the portlet container
has a cached response for this validation tag, or
null if no cached response exists.
- getEvent() -
Method in interface javax.portlet.EventRequest
- Returns the event that triggered the call to the processEvent method.
- getEvent() -
Method in class javax.portlet.filter.EventRequestWrapper
- The default behavior of this method is to call
getEvent() on the wrapped request object.
- getExpirationTime() -
Method in interface javax.portlet.CacheControl
- Get the currently set expiration time.
- getFailedKeys() -
Method in exception javax.portlet.ValidatorException
- Returns the keys that failed the validation.
- getFilterName() -
Method in interface javax.portlet.filter.FilterConfig
- Returns the filter-name of this filter as defined in the
portlet deployment descriptor.
- getId() -
Method in interface javax.portlet.PortletSession
- Returns a string containing the unique identifier assigned to this session.
- getInitParameter(String) -
Method in interface javax.portlet.filter.FilterConfig
- Returns a String containing the value of the named
initialization parameter, or
null if the parameter does not exist.
- getInitParameter(String) -
Method in class javax.portlet.GenericPortlet
- Returns a String containing the value of the named initialization * parameter, or null if the parameter does not exist.
- getInitParameter(String) -
Method in interface javax.portlet.PortletConfig
- Returns a String containing the value of the named initialization parameter,
or null if the parameter does not exist.
- getInitParameter(String) -
Method in interface javax.portlet.PortletContext
- Returns a String containing the value of the named context-wide
initialization parameter, or
null if the parameter does not exist.
- getInitParameterNames() -
Method in interface javax.portlet.filter.FilterConfig
- Returns the names of the filter's initialization parameters
as an Enumeration of String objects, or an empty Enumeration
if the filter has no initialization parameters.
- getInitParameterNames() -
Method in class javax.portlet.GenericPortlet
- Returns the names of the portlet initialization parameters as an
Enumeration of String objects, or an empty Enumeration if the portlet has
no initialization parameters.
- getInitParameterNames() -
Method in interface javax.portlet.PortletConfig
- Returns the names of the portlet initialization parameters as an
Enumeration of String objects, or an empty Enumeration if the
portlet has no initialization parameters.
- getInitParameterNames() -
Method in interface javax.portlet.PortletContext
- Returns the names of the context initialization parameters as an
Enumeration of String objects, or an empty Enumeration if the context
has no initialization parameters.
- getLastAccessedTime() -
Method in interface javax.portlet.PortletSession
- Returns the last time the client sent a request associated with this session,
as the number of milliseconds since midnight January 1, 1970 GMT.
- getLocale() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getLocale() on the wrapped request object.
- getLocale() -
Method in class javax.portlet.filter.RenderResponseWrapper
- The default behavior of this method is to call
getLocale() on the wrapped response object.
- getLocale() -
Method in class javax.portlet.filter.ResourceResponseWrapper
- The default behavior of this method is to call
getLocale() on the wrapped response object.
- getLocale() -
Method in interface javax.portlet.MimeResponse
- Returns the locale assigned to the response.
- getLocale() -
Method in interface javax.portlet.PortletRequest
- Returns the preferred Locale in which the portal will accept content.
- getLocales() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getLocales() on the wrapped request object.
- getLocales() -
Method in interface javax.portlet.PortletRequest
- Returns an Enumeration of Locale objects indicating, in decreasing
order starting with the preferred locale in which the portal will
accept content for this request.
- getMajorVersion() -
Method in interface javax.portlet.PortletContext
- Returns the major version of the Portlet API that this portlet
container supports.
- getMap() -
Method in interface javax.portlet.PortletPreferences
- Returns a
Map of the preferences.
- getMaxInactiveInterval() -
Method in interface javax.portlet.PortletSession
- Returns the maximum time interval, in seconds, for which the portlet container
keeps this session open between client accesses.
- getMethod() -
Method in interface javax.portlet.ClientDataRequest
- Returns the name of the HTTP method with which this request was made,
for example, GET, POST, or PUT.
- getMethod() -
Method in interface javax.portlet.EventRequest
- Returns the name of the HTTP method with which the original action request was made,
for example, POST, or PUT.
- getMethod() -
Method in class javax.portlet.filter.ActionRequestWrapper
- The default behavior of this method is to call
getMethod() on the wrapped request object.
- getMethod() -
Method in class javax.portlet.filter.EventRequestWrapper
- The default behavior of this method is to call
getMethod() on the wrapped request object.
- getMethod() -
Method in class javax.portlet.filter.ResourceRequestWrapper
- The default behavior of this method is to call
getMethod() on the wrapped request object.
- getMimeType(String) -
Method in interface javax.portlet.PortletContext
- Returns the MIME type of the specified file, or
null if
the MIME type is not known.
- getMinorVersion() -
Method in interface javax.portlet.PortletContext
- Returns the minor version of the Portlet API that this portlet
container supports.
- getMode() -
Method in exception javax.portlet.PortletModeException
- Returns the unsupported portlet mode causing this exception.
- getName() -
Method in interface javax.portlet.Event
- Get the local part of the event name.
- getNamedDispatcher(String) -
Method in interface javax.portlet.PortletContext
- Returns a
PortletRequestDispatcher object that acts
as a wrapper for the named servlet.
- getNames() -
Method in interface javax.portlet.PortletPreferences
- Returns all of the keys that have an associated value,
or an empty
Enumeration if no keys are
available.
- getNamespace() -
Method in class javax.portlet.filter.PortletResponseWrapper
- The default behavior of this method is to call
getNamespace() on the wrapped response object.
- getNamespace() -
Method in interface javax.portlet.PortletResponse
- The value returned by this method should be prefixed or appended to
elements, such as JavaScript variables or function names, to ensure they
are unique in the context of the portal page.
- getNextPossiblePortletModes(RenderRequest) -
Method in class javax.portlet.GenericPortlet
- Used by the render method to set the next possible portlet modes.
- getParameter(String) -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getParameter(String name) on the wrapped request object.
- getParameter(String) -
Method in interface javax.portlet.PortletRequest
- Returns the value of a request parameter as a
String,
or null if the parameter does not exist.
- getParameterMap() -
Method in interface javax.portlet.BaseURL
- Returns a
Map of the parameters
currently set on this portlet URL via the
setParameter or setParameters
methods.
- getParameterMap() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getParameterMap() on the wrapped request object.
- getParameterMap() -
Method in interface javax.portlet.PortletRequest
- Returns a
Map of the parameters of this request.
- getParameterNames() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getParameterNames() on the wrapped request object.
- getParameterNames() -
Method in interface javax.portlet.PortletRequest
- Returns an
Enumeration of String
objects containing the names of the parameters contained
in this request.
- getParameterValues(String) -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getParameterValues(name) on the wrapped request object.
- getParameterValues(String) -
Method in interface javax.portlet.PortletRequest
- Returns an array of
String objects containing
all of the values the given request parameter has, or
null if the parameter does not exist.
- getPortalContext() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getPortalContext() on the wrapped request object.
- getPortalContext() -
Method in interface javax.portlet.PortletRequest
- Returns the context of the calling portal.
- getPortalInfo() -
Method in interface javax.portlet.PortalContext
- Returns information about the portal like vendor, version, etc.
- getPortletConfig() -
Method in class javax.portlet.GenericPortlet
- Returns the PortletConfig object of this portlet.
- getPortletContext() -
Method in interface javax.portlet.filter.FilterConfig
- Returns a reference to the
PortletContext in which the caller is executing.
- getPortletContext() -
Method in class javax.portlet.GenericPortlet
- Returns the
PortletContext of the portlet application the
portlet is in.
- getPortletContext() -
Method in interface javax.portlet.PortletConfig
- Returns the
PortletContext of the portlet application
the portlet is in.
- getPortletContext() -
Method in interface javax.portlet.PortletSession
- Returns the portlet application context associated with this session.
- getPortletContextName() -
Method in interface javax.portlet.PortletContext
- Returns the name of this portlet application correponding to this PortletContext as specified
in the
web.xml deployment descriptor for this web application by the
display-name element.
- getPortletInputStream() -
Method in interface javax.portlet.ClientDataRequest
- Retrieves the body of the HTTP request from client to
portal as binary data using
an
InputStream.
- getPortletInputStream() -
Method in class javax.portlet.filter.ActionRequestWrapper
- The default behavior of this method is to call
getPortletInputStream() on the wrapped request object.
- getPortletInputStream() -
Method in class javax.portlet.filter.ResourceRequestWrapper
- The default behavior of this method is to call
getPortletInputStream() on the wrapped request object.
- getPortletMode() -
Method in class javax.portlet.filter.ActionResponseWrapper
- The default behavior of this method is to call
getPortletMode() on the wrapped response object.
- getPortletMode() -
Method in class javax.portlet.filter.EventResponseWrapper
- The default behavior of this method is to call
getPortletMode() on the wrapped response object.
- getPortletMode() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getPortletMode() on the wrapped request object.
- getPortletMode() -
Method in interface javax.portlet.PortletRequest
- Returns the current portlet mode of the portlet.
- getPortletMode() -
Method in interface javax.portlet.PortletURL
- Returns the currently set portlet mode on this PortletURL.
- getPortletMode() -
Method in interface javax.portlet.StateAwareResponse
- Returns the currently set portlet mode on this reponse.
- getPortletName() -
Method in class javax.portlet.GenericPortlet
- Returns the name of this portlet.
- getPortletName() -
Method in interface javax.portlet.PortletConfig
- Returns the name of the portlet.
- getPortletOutputStream() -
Method in class javax.portlet.filter.RenderResponseWrapper
- The default behavior of this method is to call
getPortletOutputStream() on the wrapped response object.
- getPortletOutputStream() -
Method in class javax.portlet.filter.ResourceResponseWrapper
- The default behavior of this method is to call
getPortletOutputStream() on the wrapped response object.
- getPortletOutputStream() -
Method in interface javax.portlet.MimeResponse
- Returns a
OutputStream suitable for writing binary data in
the response.
- getPortletSession() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getPortletSession() on the wrapped request object.
- getPortletSession(boolean) -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getPortletSession(create) on the wrapped request object.
- getPortletSession() -
Method in interface javax.portlet.PortletRequest
- Returns the current portlet session or, if there is no current session,
creates one and returns the new session.
- getPortletSession(boolean) -
Method in interface javax.portlet.PortletRequest
- Returns the current portlet session or, if there is no current session
and the given flag is
true, creates one and returns
the new session.
- getPreferences() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getPreferences() on the wrapped request object.
- getPreferences() -
Method in interface javax.portlet.PortletRequest
- Returns the preferences object associated with the portlet.
- getPrivateParameterMap() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getPrivateParameterMap() on the wrapped request object.
- getPrivateParameterMap() -
Method in interface javax.portlet.PortletRequest
- Returns a
Map of the private parameters of this request.
- getPrivateRenderParameterMap() -
Method in class javax.portlet.filter.ResourceRequestWrapper
- The default behavior of this method is to call
getPrivateRenderParameterMap() on the wrapped request object.
- getPrivateRenderParameterMap() -
Method in interface javax.portlet.ResourceRequest
- Returns a
Map of the private render parameters of this request.
- getProcessingEventQNames() -
Method in class javax.portlet.GenericPortlet
-
- getProcessingEventQNames() -
Method in interface javax.portlet.PortletConfig
- Returns the QNames of the processing events supported by the portlet
as an
Enumeration of QName objects,
or an empty Enumeration if the
portlet has not defined any processing events.
- getProperties(String) -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getProperteis(name) on the wrapped request object.
- getProperties(String) -
Method in interface javax.portlet.PortletRequest
- Returns all the values of the specified request property
as a
Enumeration of String objects.
- getProperty(String) -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getProperty(name) on the wrapped request object.
- getProperty(String) -
Method in interface javax.portlet.PortalContext
- Returns the portal property with the given name,
or a
null if there is
no property by that name.
- getProperty(String) -
Method in interface javax.portlet.PortletRequest
- Returns the value of the specified request property
as a
String.
- getPropertyNames() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getPropertyNames() on the wrapped request object.
- getPropertyNames() -
Method in interface javax.portlet.PortalContext
- Returns all portal property names, or an empty
Enumeration if there are no property names.
- getPropertyNames() -
Method in interface javax.portlet.PortletRequest
- Returns a
Enumeration of all the property names
this request contains.
- getPublicParameterMap() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getPublicParameterMap() on the wrapped request object.
- getPublicParameterMap() -
Method in interface javax.portlet.PortletRequest
- Returns a
Map of the public parameters of this request.
- getPublicRenderParameterNames() -
Method in class javax.portlet.GenericPortlet
- Returns the names of the public render parameters supported by the
portlet as an
Enumeration of String objects, or an empty
Enumeration if the portlet has no public render
parameters.
- getPublicRenderParameterNames() -
Method in interface javax.portlet.PortletConfig
- Returns the names of the public render parameters supported by the portlet
as an
Enumeration of String objects,
or an empty Enumeration if the
portlet has not defined public render parameters.
- getPublishingEventQNames() -
Method in class javax.portlet.GenericPortlet
-
- getPublishingEventQNames() -
Method in interface javax.portlet.PortletConfig
- Returns the QNames of the publishing events supported by the portlet
as an
Enumeration of QName objects,
or an empty Enumeration if the
portlet has not defined any publishing events.
- getQName() -
Method in interface javax.portlet.Event
- Get the event QName.
- getReader() -
Method in interface javax.portlet.ClientDataRequest
- Retrieves the body of the HTTP request from the client to the portal
as character data using
a
BufferedReader.
- getReader() -
Method in class javax.portlet.filter.ActionRequestWrapper
- The default behavior of this method is to call
getReader() on the wrapped request object.
- getReader() -
Method in class javax.portlet.filter.ResourceRequestWrapper
- The default behavior of this method is to call
getReader() on the wrapped request object.
- getRealPath(String) -
Method in interface javax.portlet.PortletContext
- Returns a
String containing the real path
for a given virtual path.
- getRemoteUser() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getRemoteUser() on the wrapped request object.
- getRemoteUser() -
Method in interface javax.portlet.PortletRequest
- Returns the login of the user making this request, if the user
has been authenticated, or null if the user has not been authenticated.
- getRenderParameterMap() -
Method in class javax.portlet.filter.ActionResponseWrapper
- The default behavior of this method is to call
getRenderParameterMap() on the wrapped response object.
- getRenderParameterMap() -
Method in class javax.portlet.filter.EventResponseWrapper
- The default behavior of this method is to call
getRenderParameterMap() on the wrapped response object.
- getRenderParameterMap() -
Method in interface javax.portlet.StateAwareResponse
- Returns a
Map of the render parameters currently set on
this response.
- getRequest() -
Method in class javax.portlet.filter.ActionRequestWrapper
- Return the wrapped request object.
- getRequest() -
Method in class javax.portlet.filter.EventRequestWrapper
- Return the wrapped request object.
- getRequest() -
Method in class javax.portlet.filter.PortletRequestWrapper
- Return the wrapped request object.
- getRequest() -
Method in class javax.portlet.filter.RenderRequestWrapper
- Return the wrapped request object.
- getRequest() -
Method in class javax.portlet.filter.ResourceRequestWrapper
- Return the wrapped request object.
- getRequestDispatcher(String) -
Method in interface javax.portlet.PortletContext
- Returns a
PortletRequestDispatcher object that acts
as a wrapper for the resource located at the given path.
- getRequestedSessionId() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getRequestedSessionId() on the wrapped request object.
- getRequestedSessionId() -
Method in interface javax.portlet.PortletRequest
- Returns the session ID indicated in the client request.
- getResource(String) -
Method in interface javax.portlet.PortletContext
- Returns a URL to the resource that is mapped to a specified
path.
- getResourceAsStream(String) -
Method in interface javax.portlet.PortletContext
- Returns the resource located at the given path as an InputStream object.
- getResourceBundle(Locale) -
Method in class javax.portlet.GenericPortlet
- Gets the resource bundle for the given locale based on the resource
bundle defined in the deployment descriptor with
resource-bundle tag or the inlined resources defined in
the deployment descriptor.
- getResourceBundle(Locale) -
Method in interface javax.portlet.PortletConfig
- Gets the resource bundle for the given locale based on the
resource bundle defined in the deployment descriptor
with
resource-bundle tag or the inlined resources
defined in the deployment descriptor.
- getResourceID() -
Method in class javax.portlet.filter.ResourceRequestWrapper
- The default behavior of this method is to call
getResourceID() on the wrapped request object.
- getResourceID() -
Method in interface javax.portlet.ResourceRequest
- Returns the resource ID set on the ResourceURL or
null
if no resource ID was set on the URL.
- getResourcePaths(String) -
Method in interface javax.portlet.PortletContext
- Returns a directory-like listing of all the paths to resources within
the web application longest sub-path of which
matches the supplied path argument.
- getResponse() -
Method in class javax.portlet.filter.ActionResponseWrapper
- Return the wrapped response object.
- getResponse() -
Method in class javax.portlet.filter.EventResponseWrapper
- Return the wrapped response object.
- getResponse() -
Method in class javax.portlet.filter.PortletResponseWrapper
- Return the wrapped response object.
- getResponse() -
Method in class javax.portlet.filter.RenderResponseWrapper
- Return the wrapped response object.
- getResponse() -
Method in class javax.portlet.filter.ResourceResponseWrapper
- Return the wrapped response object.
- getResponseContentType() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getResponseContentType() on the wrapped request object.
- getResponseContentType() -
Method in interface javax.portlet.PortletRequest
- Returns the portal preferred content type for the response.
- getResponseContentType() -
Method in interface javax.portlet.ResourceRequest
- Returns the portal preferred content type for the response.
- getResponseContentTypes() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getResponseContentTypes() on the wrapped request object.
- getResponseContentTypes() -
Method in interface javax.portlet.PortletRequest
- Gets a list of content types which the portal accepts for the response.
- getResponseContentTypes() -
Method in interface javax.portlet.ResourceRequest
- Gets a list of content types which the portal accepts for the response.
- getScheme() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getScheme() on the wrapped request object.
- getScheme() -
Method in interface javax.portlet.PortletRequest
- Returns the name of the scheme used to make this request.
- getServerInfo() -
Method in interface javax.portlet.PortletContext
- Returns the name and version of the portlet container in which the
portlet is running.
- getServerName() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getServerName() on the wrapped request object.
- getServerName() -
Method in interface javax.portlet.PortletRequest
- Returns the host name of the server that received the request.
- getServerPort() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getServerPort() on the wrapped request object.
- getServerPort() -
Method in interface javax.portlet.PortletRequest
- Returns the port number on which this request was received.
- getState() -
Method in exception javax.portlet.WindowStateException
- Returns the portlet state causing this exception.
- getSupportedLocales() -
Method in class javax.portlet.GenericPortlet
-
- getSupportedLocales() -
Method in interface javax.portlet.PortletConfig
- Returns the locales supported by the portlet
as an
Enumeration of Locale objects,
or an empty Enumeration if the
portlet has not defined any supported locales.
- getSupportedPortletModes() -
Method in interface javax.portlet.PortalContext
- Returns all supported portlet modes by the portal
as an enumeration of
PortletMode objects.
- getSupportedWindowStates() -
Method in interface javax.portlet.PortalContext
- Returns all supported window states by the portal
as an enumeration of
WindowState objects.
- getTitle(RenderRequest) -
Method in class javax.portlet.GenericPortlet
- Used by the render method to get the title.
- getUnavailableSeconds() -
Method in exception javax.portlet.UnavailableException
- Returns the time in seconds for which the portlet can be expected to
be unavailable.
- getUserPrincipal() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getUserPrincipal() on the wrapped request object.
- getUserPrincipal() -
Method in interface javax.portlet.PortletRequest
- Returns a java.security.Principal object containing the name of the
current authenticated user.
- getValue() -
Method in interface javax.portlet.Event
- Get the event payload.
- getValue(String, String) -
Method in interface javax.portlet.PortletPreferences
- Returns the first String value associated with the specified key of this preference.
- getValues(String, String[]) -
Method in interface javax.portlet.PortletPreferences
- Returns the String array value associated with the specified key in this preference.
- getWindowID() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getWindowId() on the wrapped request object.
- getWindowID() -
Method in interface javax.portlet.PortletRequest
- Returns the portlet window ID.
- getWindowState() -
Method in class javax.portlet.filter.ActionResponseWrapper
- The default behavior of this method is to call
getWindowState() on the wrapped response object.
- getWindowState() -
Method in class javax.portlet.filter.EventResponseWrapper
- The default behavior of this method is to call
getWindowState() on the wrapped response object.
- getWindowState() -
Method in class javax.portlet.filter.PortletRequestWrapper
- The default behavior of this method is to call
getWindowState() on the wrapped request object.
- getWindowState() -
Method in interface javax.portlet.PortletRequest
- Returns the current window state of the portlet.
- getWindowState() -
Method in interface javax.portlet.PortletURL
- Returns the currently set window state on this PortletURL.
- getWindowState() -
Method in interface javax.portlet.StateAwareResponse
- Returns the currently set window state on this response.
- getWriter() -
Method in class javax.portlet.filter.RenderResponseWrapper
- The default behavior of this method is to call
getWriter() on the wrapped response object.
- getWriter() -
Method in class javax.portlet.filter.ResourceResponseWrapper
- The default behavior of this method is to call
getWriter() on the wrapped response object.
- getWriter() -
Method in interface javax.portlet.MimeResponse
- Returns a PrintWriter object that can send character text to the portal.
HELP portlet mode, a portlet should provide help
information about the portlet.
setProperty method.
super.init(config).
isCommitted() on the wrapped response object.
isCommitted() on the wrapped response object.
boolean indicating
whether the portlet is permanently unavailable.
isPortletModeAllowed(mode) on the wrapped request object.
isRequestedSessionIdValid() on the wrapped request object.
isSecure() on the wrapped request object.
isUserInRole(role) on the wrapped request object.
isWindowStateAllowed(state) on the wrapped request object.
MimeResponse property MARKUP_HEAD_ELEMENT.
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.
MimeResponse defines the base interface to assist a
portlet in returning MIME content.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.
PAGE may contain artifacts that require
knowledge of the state of the complete page, like
PortletURLs.
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.PORTLRET does not need to contain the
current state of the page, but the current render parameters, portlet
mode, or window state of the portlet must be accessible to the portlet.
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.PortletFilter is the base interface for all portlet filters.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.PortletRequestWrapper provides a convenient
implementation of the PortletRequest interface
and is extended by other request wrappers.PortletRequest adaptor
wrapping the given request object.
PortletResponse defines the base interface to assist a
portlet in creating and sending a response to the client.PortletResponseWrapper provides a convenient
implementation of the PortletResponse interface
and is extended by other response wrappers.ActionResponse adaptor
wrapping the given response object.
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.@ProcessEvent that matches the
event name or, if no
such method is found just sets the current render parameters on
the response.
Note that the annotated methods needs to be public in order
to be allowed to be called by GenericPortlet.
- ProcessEvent - Annotation Type in javax.portlet
- Annotation for marking a method for handling
a specific event.
- PUBLIC_SCOPE -
Static variable in interface javax.portlet.MimeResponse
- Public cache scope, indicating that the cache entry can be shared across
users.
ReadOnlyException is thrown when a portlet tries
to change the value for a read-only preference attribute.removeAttribute(name) on the wrapped request object.
PORTLET_SCOPE from
this session.
removePublicRenderParameter() on the wrapped response object.
removePublicRenderParameter() on the wrapped response object.
doHeaders method, sets the title using the
getTitle method and invokes the doDispatch
method.
RenderFilter is an object that performs filtering
tasks on either the render request to a portlet, or on the render response from
a portlet, or both.RenderRequest represents the request sent to the portlet
to handle a render.RenderRequestWrapper provides a convenient
implementation of the RenderRequest interface
that can be subclassed by developers wishing to adapt the request.RenderRequest adaptor
wrapping the given request object.
RenderResponse defines an object to assist a portlet in
sending a response to the portal.RenderResponseWrapper provides a convenient
implementation of the RenderResponse interface
that can be subclassed by developers wishing to adapt the response.RenderResponse adaptor
wrapping the given response object.
reset() on the wrapped response object.
reset() on the wrapped response object.
resetBuffer() on the wrapped response object.
resetBuffer() on the wrapped response object.
ResourceFilter is an object that performs filtering
tasks on either the resource request to a portlet, or on the resource response from
a portlet, or both.ResourceRequest interface represents the request
send to the portlet for rendering resources.ResourceRequestWrapper provides a convenient
implementation of the ResourceRequest interface
that can be subclassed by developers wishing to adapt the request.ResourceRequest adaptor
wrapping the given request object.
ResourceResponse defines an object to assist a portlet
for rendering a resource.ResourceResponseWrapper provides a convenient
implementation of the ResourceResponse interface
that can be subclassed by developers wishing to adapt the response.ResourceResponse adaptor
wrapping the given response object.
ResourceServingPortlet interface allows
serving resources through the portlet.ResourceURL defines a resource URL that when clicked will
result in a serveResource call of the
ResourceServingPortlet interface.sendRedirect(location) on the wrapped response object.
sendRedirect(location, renderUrlParamName) on the wrapped response object.
setAttribute(name, o) on the wrapped request object.
PORTLET_SCOPE, using the name specified.
setBufferSize(size) on the wrapped response object.
setBufferSize(size) on the wrapped response object.
setCharacterEncoding(String enc)
on the wrapped request object.
setCharacterEncoding(String enc)
on the wrapped request object.
setCharacterEncoding(String charset) on the wrapped response object.
setContentLength() on the wrapped response object.
setContentType(type) on the wrapped response object.
setContentType(type) on the wrapped response object.
setEvent(name, value) on the wrapped response object.
setEvent() on the wrapped response object.
setEvent(name, value) on the wrapped response object.
setEvent() on the wrapped response object.
setLocale(Locale loc) on the wrapped response object.
setNextPossiblePortletModes() on the wrapped response object.
setPortletMode(portletMode) on the wrapped response object.
setPortletMode(portletMode) on the wrapped response object.
setProperty(key, value) on the wrapped response object.
true as
publicScope and to private with
false as publicScope.
setRenderParameter(key, value) on the wrapped response object.
setRenderParameter(key, value) on the wrapped response object.
setRenderParameter(key, value) on the wrapped response object.
setRenderParameter(key, value) on the wrapped response object.
setRenderParameters(parameters) on the wrapped response object.
setRenderParameters(parameters) on the wrapped response object.
setRenderParameters() on the wrapped response object.
ResourceRequest.getResourceID() method.
setTitle(title) on the wrapped response object.
setWindowState(windowState) on the wrapped response object.
setWindowState(windowState) on the wrapped response object.
FULL via the setProperty method
on the ResourceURL.
StateAwareResponse represents a response that can modify
state information or send events.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.
|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||