|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.avalon.framework.logger.AbstractLogEnabled
org.apache.cocoon.environment.AbstractEnvironment
org.apache.cocoon.environment.portlet.PortletEnvironment
Implements Environment
interface for the JSR-168
Portlet environment.
Field Summary | |
static String |
HEADER_PORTLET_MODE
This header can be read from any portlet request, and can be set on action response. |
static String |
HEADER_PORTLET_TITLE
This header can be set only, and only on render response. |
static String |
HEADER_WINDOW_STATE
This header can be read from any portlet request, and can be set on action response. |
static String |
PARAMETER_PATH_INFO
As portlets do not have a pathInfo in the request, we can simulate this by passing a parameter. |
static String |
SESSION_APPLICATION_SCOPE
This is the prefix for application scope session attributes. |
static String |
SESSION_PORTLET_SCOPE
This is the prefix for portlet scope session attributes. |
Fields inherited from class org.apache.cocoon.environment.AbstractEnvironment |
action, objectModel, outputStream, prefix, secureOutputStream, uri, view |
Constructor Summary | |
PortletEnvironment(String servletPath,
String pathInfo,
String uri,
javax.portlet.ActionRequest request,
javax.portlet.ActionResponse response,
javax.portlet.PortletContext portletContext,
Context context,
String containerEncoding,
String defaultFormEncoding,
int defaultSessionScope)
Constructs a PortletEnvironment object from a PortletRequest and PortletResponse objects |
|
PortletEnvironment(String servletPath,
String pathInfo,
String uri,
javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response,
javax.portlet.PortletContext portletContext,
Context context,
String containerEncoding,
String defaultFormEncoding,
int defaultSessionScope)
Constructs a PortletEnvironment object from a PortletRequest and PortletResponse objects |
Method Summary | |
String |
getContentType()
Get the ContentType |
OutputStream |
getOutputStream(int bufferSize)
Get the output stream where to write the generated resource. |
boolean |
isExternal()
Always return true . |
boolean |
isResponseModified(long lastModified)
This method always returns true because portlet environment does not support response codes. |
void |
redirect(String newURL,
boolean global,
boolean permanent)
Redirect to the given URL |
void |
setContentLength(int length)
Portlet environment does not support response content length. |
void |
setContentType(String contentType)
Set the ContentType |
void |
setResponseIsNotModified()
Portlet environment does not support response status code. |
void |
setStatus(int statusCode)
Portlet environment does not support response status code. |
boolean |
tryResetResponse()
Reset the response if possible. |
Methods inherited from class org.apache.cocoon.environment.AbstractEnvironment |
commitResponse, extractAction, extractView, finishingProcessing, getAction, getAttribute, getAttributeNames, getObjectModel, getURI, getURIPrefix, getView, isInternalRedirect, removeAttribute, setAction, setAttribute, setURI, setView, startingProcessing |
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled |
enableLogging, getLogger, setupLogger, setupLogger, setupLogger |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String PARAMETER_PATH_INFO
public static final String HEADER_PORTLET_MODE
public static final String HEADER_WINDOW_STATE
public static final String HEADER_PORTLET_TITLE
public static final String SESSION_APPLICATION_SCOPE
public static final String SESSION_PORTLET_SCOPE
Constructor Detail |
public PortletEnvironment(String servletPath, String pathInfo, String uri, javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, javax.portlet.PortletContext portletContext, Context context, String containerEncoding, String defaultFormEncoding, int defaultSessionScope) throws IOException
public PortletEnvironment(String servletPath, String pathInfo, String uri, javax.portlet.RenderRequest request, javax.portlet.RenderResponse response, javax.portlet.PortletContext portletContext, Context context, String containerEncoding, String defaultFormEncoding, int defaultSessionScope) throws IOException
Method Detail |
public void redirect(String newURL, boolean global, boolean permanent) throws IOException
Environment
IOException
public void setStatus(int statusCode)
setStatus
in interface Environment
setStatus
in class AbstractEnvironment
public void setContentType(String contentType)
public String getContentType()
public void setContentLength(int length)
public boolean isResponseModified(long lastModified)
isResponseModified
in interface Environment
isResponseModified
in class AbstractEnvironment
public void setResponseIsNotModified()
setResponseIsNotModified
in interface Environment
setResponseIsNotModified
in class AbstractEnvironment
public boolean tryResetResponse() throws IOException
tryResetResponse
in interface Environment
tryResetResponse
in class AbstractEnvironment
IOException
public OutputStream getOutputStream(int bufferSize) throws IOException
getOutputStream
in interface Environment
getOutputStream
in class AbstractEnvironment
IOException
public boolean isExternal()
true
.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |