javax.portlet.ResourceRequest Maven / Gradle / Ivy
Show all versions of portlet-api_2.1.0_spec Show documentation
/* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* This source code implements specifications defined by the Java
* Community Process. In order to remain compliant with the specification
* DO NOT add / change / or delete method signatures!
*/
package javax.portlet;
/**
* The ResourceRequest interface represents the request
* send to the portlet for rendering resources.
*
* It extends the ClientDataRequest interface and provides resource request
* information to portlets.
*
* The portlet container creates an ResourceRequest object and
* passes it as argument to the portlet's serveResource method.
*
* The ResourceRequest is provided with the current portlet mode, window state,
* and render parameters that the portlet can access via the
* PortletResourceRequest with getPortletMode and,
* getWindowState, or one of the getParameter methods.
* ResourceURLs cannot change the current portlet mode, window state or
* render parameters. Parameters set on a resource URL are not render parameters
* but parameters for serving this resource and will last only for only
* this the current serveResource request.
* If a parameter is set that has the same name as a render parameter that this
* resource URL contains, the render parameter must be the last entry in the
* parameter value array.
*
* @see ClientDataRequest
* @see ResourceServingPortlet
* @since 2.0
*/
public interface ResourceRequest extends ClientDataRequest {
/**
* This property is set by the container if the container
* has a cached response for the given validation tag. The property can be
* retrieved using the getProperty method.
*
* The value is "portlet.ETag ".
*/
public static final String ETAG = "portlet.ETag";
/**
* Returns the validation tag if the portlet container
* has a cached response for this validation tag, or
* null if no cached response exists.
*
* This call returns the same value as
* ResourceRequest.getProperty(ResourceRequest.ETAG).
*
* @return the validation tag if the portlet container
* has a cached response for this validation tag, or
* null if no cached response exists.
*/
public String getETag();
/**
* Returns the resource ID set on the ResourceURL or null
* if no resource ID was set on the URL.
*
* Note that if the resource ID is to be used as the target for a
* PortletRequestDispatcher forward or include, it should be checked for
* validity before use.
*
* @return the resource ID set on the ResourceURL,or null
* if no resource ID was set on the URL.
*/
public String getResourceID();
/**
* Returns a Map of the private render parameters of this request.
* Private parameters are not shared with other portlets or components.
* The returned parameters are "x-www-form-urlencoded" decoded.
*
* The parameters returned do not include the resource parameters that
* the portlet may have set on the resource URL triggering this
* serveResource call.
*
* The values in the returned Map are from type
* String array (String[]).
*
* If no private parameters exist this method returns an empty Map.
*
* @return an immutable Map containing private parameter names as
* keys and private parameter values as map values, or an empty Map
* if no private parameters exist. The keys in the parameter
* map are of type String. The values in the parameter map are of type
* String array (String[]).
*/
public java.util.Map getPrivateRenderParameterMap();
/**
* Returns the portal preferred content type for the response.
*
* The returned content type should be based on the HTTP Accept header
* provided by the client.
*
* @return preferred content type of the response
*/
public String getResponseContentType();
/**
* Gets a list of content types which the portal accepts for the response.
* This list is ordered with the most preferable types listed first.
*
* The returned content types should be based on the HTTP Accept header
* provided by the client.
*
* @return ordered list of content types for the response
*/
public java.util.Enumeration getResponseContentTypes();
/**
* Returns the cache level of this resource request.
*
* Possible return values are:
* ResourceURL.FULL, ResourceURL.PORTLET
* or ResourceURL.PAGE.
*
* @return the cache level of this resource request.
*/
public String getCacheability();
}