See: Description
Package | Description |
---|---|
javax.portlet |
The javax.portlet package defines the API
for the Java Portlet Specification V3.0.
|
javax.portlet.annotations |
The javax.portlet.annotations package provides the annotations used
for portlet configuration and portlet-specific dependency injection.
|
javax.portlet.filter |
The javax.portlet.filter package defines the filter APIs for the Java Portlet Specification.
|
The portlet hub JavaScript API documentation can be found here.
Color coding for description changes in Version 3.0: Changed text :: Added text :: Deleted text as compared to Version 2.0.
Change History:
InitMethod
and
DestroyMethod
.
Changed the default content type to '*/*' in the annotations
HeaderMethod
,
RenderMethod
, and
ServeResourceMethod
.
package-info
.
Changed portlet hub JavaScript documentation
to move the parameter manipulation methods from the
PortletParameters
object to the
RenderState
object.
Added optional resource ID string parameter to the portlet hub
createResourceUrl
function.
@RenderParam
,
@ActionParam
, and
@ResourceParam
since they can't be made to be request scoped beans,
so that their use could be error-prone. Also, since the corresponding parameter
objects are injectable, these annotations provide little additional value.
PortletRequest#getResponseContentType()
and
PortletRequest#getResponseContentTypes()
to remove redundant clause on the content types being declared in the portlet configuration,
since the portlet won't be invoked for a content type that hasn't been configured.
PortletAsyncContextWrapper
.
Modified descriptions for
BaseURL#write(String, boolean)
and
BaseURL#append(String, boolean)
to update documentation on escape XML flag handling.
URLFactory
interface, as a MimeResponse
object
can be injected instead with no loss of functionality.
Added the
PortletName
qualifier annotation for
injection of the portlet name.
Deleted the @BeanPortlet
qualifier annotation as it is no longer needed
for disambiguation.
Deleted the @InitMethod
and @DestroyMethod
annotations, as the
CDI annotations @PostConstruct
and @PreDestroy
annotations
should be used for bean initialization and tear down instead.
Renamed @PortletRequestFilter
to
PortletLifecycleFilter
,
Changed method name from ActionResponse#getRedirectURL to
ActionResponse.createRedirectURL()
.
HeaderResponse.addDependency(String, String, String, String)
.
ResourceRequest#startPortletAsync()
,
ResourceRequest#startPortletAsync(ResourceRequest, ResourceResponse)
, and
ResourceRequest#getPortletAsyncContext()
from startAsync()
, startAsync(ResourceRequest, ResourceResponse)
and getAsyncContext()
, respectively.
Added new methods
HeaderResponse.addDependency(String, String, String)
and
HeaderResponse.addDependency(String, String, String, String)
to dynamically add page resource dependencies in fulfillment of issue
PORTLETSPEC3-40 Add new javax.portlet.ResourceComparator annotation in order to identify duplicate resources.
Added
Dependency#scope()
method
to support three-part resource identifier with name, scope, and version fields.
PortletRequest#getUserAgent()
.
and altered the corresponding wrapper class accordingly.
Removed the PortletRequest#USER_AGENT constant, as an alternative implementation was agreed upon.
Added multipart support to fulfill
PORTLETSPEC3-67.
See
PortletConfiguration#multipart()
,
Multipart
,
ClientDataRequest.getPart(String)
, and
ClientDataRequest.getParts()
.
PortletAsyncContext
,
PortletAsyncListener
, and
PortletAsyncEvent
.
Modified
ResourceRequest#startPortletAsync()
,
ResourceRequest#startPortletAsync(ResourceRequest, ResourceResponse)
, and
ResourceRequest#getPortletAsyncContext()
along with the corresponding wrapper class accordingly.
PortletConfiguration#asyncSupported()
,
ServeResourceMethod#asyncSupported()
,
ResourceRequest#startPortletAsync()
,
ResourceRequest#startPortletAsync(ResourceRequest, ResourceResponse)
,
ResourceRequest#isAsyncStarted()
,
ResourceRequest#isAsyncSupported()
,
ResourceRequest#getPortletAsyncContext()
, and
ResourceRequest#getDispatcherType()
.
Added appropriate documentation to
ResourceFilter
.
Updated affected wrapper classes accordingly.
PortletRequest#getPortletContext()
and
ClientDataRequest#getContentLengthLong()
.
Updated affected wrapper classes accordingly.
RenderState
,
MutableRenderState
,
HeaderMethod
, and
RenderMethod
.
PortalContextWrapper
.
Removed the annotation ConditionalDispatchMethod along with the associated interfaces
MethodToken and ConditionalDispatcher, as they will not be included in the V3 specification.
getClassLoader
,
getContextPath
,
getEffectiveMajorVersion
, and
getEffectiveMinorVersion
.
Added new PortletResponse methods according to
PORTLETSPEC3-60:
getProperty
,
getPropertyNames
, and
getPropertyValues
.
Added new ResourceResponse methods according to
PORTLETSPEC3-60:
setContentLengthLong
and
getStatus
.
PortletResponse
addProperty and setProperty
method descriptions.
Removed BaseURL
getAuthenticated and setAuthenticated methods.
Added wrappers according to
PORTLETSPEC3-62,
(see filter package
).
Update following annotations for consistency with spec & RI:
DestroyMethod,
EventMethod
,
HeaderMethod
,
InitMethod,
PortletSessionScoped
.
Added PortletRequestScoped
annotation.
InitParameter
,
PortletConfiguration
,
PortletRequestFilter,
RuntimeOption
,
SecurityRoleRef
,
Supports
.
HeaderMethod
,
RenderMethod
, and
ServeResourceMethod
.
HeaderFilterChain
and updated
HeaderFilter
to use it.
ClientDataRequestWrapper
,
HeaderFilter
,
HeaderRequestWrapper
,
HeaderResponseWrapper
,
MimeResponseWrapper
, and
StateAwareResponseWrapper
.
Modified classes:
ActionRequestWrapper
,
ActionResponseWrapper
,
RenderRequestWrapper
,
RenderResponseWrapper
,
EventRequestWrapper
,
EventResponseWrapper
,
PortletRequestWrapper
,
PortletResponseWrapper
,
ResourceRequestWrapper
, and
ResourceResponseWrapper
.
HEAD
section.
Deprecated RenderResponse#setTitle
since it is more appropriate on the HeaderResponse object.
Added classes:
HeaderRequest
,
HeaderResponse
, and
HeaderPortlet
.
Modified classes:
RenderMethod
,
HeaderMethod
, and
ServeResourceMethod
.
UserAttribute
,
EventDefinition
,
PortletApplication
,
PortletConfigurations
,
PublicRenderParameterDefinition
, and
SecurityRoleRef
.
Modified classes:
ActionMethod
,
CustomPortletMode
,
CustomWindowState
,
Dependency
,
EventMethod
,
PortletConfiguration
,
PortletQName
,
RenderStateScoped
,
Preference
, and
Supports
.
PortletConfigurations
to allow
for configuration of multiple portlets within a single annotation.
PortletURL.setBeanParameter
.
Updated annotations:
PortletSessionScoped
and
javax.portlet.annotations.URLFactory.
MimeResponse.Copy
.
Added method:
ActionResponse.getRedirectURL()
.
Updated annotations:
HeaderMethod
,
RenderMethod
, and
ServeResourceMethod
.
PortletConfiguration
.
Added annotation classes:
Supports
,
CustomPortletMode
,
CustomWindowState
.
Annotations package info file
.
Annotations package info file
.
MimeResponse.createRenderURL())
,
MimeResponse.createActionURL())
,
MutablePortletParameters.set()
,
MutablePortletParameters.add()
,
PortletURLGenerationListener.filterRenderURL()
,
PortletURLGenerationListener.filterActionURL()
.
Added method
PortletParameters.size()
.
See
PORTLETSPEC3-50
for discussion.
PortletConfig.getPortletModes(String)
and
PortletConfig.getWindowStates(String)
.
Added method
PortletConfig.getPublicRenderParameterDefinitions()
.
See
portlet configuration description.
getNames()
,
getValue
,
getValues
,
setValue(String, String)
,
getNames()
, and
setValues(String, String...)
.
setFragmentIdentifier
,
getFragmentIdentifier
,
append(Appendable)
,
append(Appendable, boolean)
add(PortletParameters)
,
getNames()
, and
setValues(String, String...)
.
Mutable
,
PortletParameters
, MutablePortletParameters
,
RenderParameters
, MutableRenderParameters
,
ResourceParameters
, MutableResourceParameters
,
ActionParameters
, MutableActionParameters
,
RenderState
, MutableRenderState
,
ActionURL
, RenderURL
.
BaseURL
, PortletURL
,
ResourceURL
, ActionURL
,
PortletRequest
, ResourceRequest
, ActionRequest
,
PortletResponse
, ResourceResponse
, MimeResponse
,
ActionRequestWrapper
, ActionResponseWrapper
, EventResponseWrapper
,
PortletRequestWrapper
, RenderResponseWrapper
, ResourceRequestWrapper
,
ResourceResponseWrapper
RenderURL
, as they are not useful on other types of URL:
setFragmentIdentifier
and
getFragmentIdentifier
See Diagram.
dispatchAnnotatedActionMethod
,
dispatchAnnotatedEventMethod
, and
dispatchAnnotatedRenderMethod
.
createActionURL()
and
createActionURL(Copy)
.
See updated spec description
portlet URLs
.
createRenderURL(Copy)
and
createActionURL(Copy)
.
Updated
RenderResponseWrapper
and
ResourceResponseWrapper
accordingly.
setFragmentIdentifier
and
getFragmentIdentifier
.
See
portlet URLs
.
PortletConfig.getPortletModes()
and
PortletConfig.getWindowStates()
.
See
portlet configuration description.
ResourceResponse.setStatus(int sc)
and
ResourceResponseWrapper.setStatus(int sc)
.
BaseURL.setParameter
,
StateAwareResponse.setRenderParameter
, and
PortletPreferences.setValues
.
GenericPortlet.doHeaders
to throw a PortletException or IOException.
BaseURL.write(Appendable)
and
BaseURL.write(Appendable, boolean)
to BaseURL. See
Portlet URLs
.
ResourceRequest.getPortletMode
and
ResourceRequest.getWindowState
behavior when the cache level is set to FULL by returning
PortletMode.UNDEFINED
and WindowState.UNDEFINED
, respectively.
MimeResponse.setContentType
.
HTTP_STATUS_CODE
,
setLocale
, and
setContentLength
.
PortletSession
methods:
getAttribute
,
getAttributeNames
,
removeAttribute
, and
getAttributeMap
.
RenderResponse.setNextPossiblePortletModes
.
StateAwareResponse.getRenderParameterMap()
,
BaseURL.getParameterMap()
,
MimeResponse
URL creation methods
createRenderURL()
,
createActionURL()
, and
createResourceURL()
StateAwareResponse
and
BaseURL
to improve clarity.
StateAwareResponse.setRenderParameters(Map)
and
BaseURL.setParameters(Map)
.
getExpirationTime()
.
getPortletSession()
getPrivateParametermap()
about private render parameters
Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.