当前页面: 在线文档首页 > JBOSS Portal 2.4 API 英文版文档

PortletResponseImpl - JBOSS Portal 2.4 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jboss.portal.portlet.impl.jsr168
Class PortletResponseImpl

java.lang.Object
  org.jboss.portal.portlet.impl.jsr168.PortletResponseImpl

All Implemented Interfaces:

PortletResponse

Direct Known Subclasses:

ActionResponseImpl, RenderResponseImpl

---

public abstract class PortletResponseImpl

extends java.lang.Object

implements PortletResponse

---

Field Summary
protected  PortletInvocation	invocation           .
protected  PortletRequestImpl	preq           .

 

Constructor Summary
protected	PortletResponseImpl(PortletInvocation invocation, PortletRequestImpl preq)

 

Method Summary
java.lang.String	encodeURL(java.lang.String url)           Returns the encoded URL of the resource, like servlets, JSPs, images and other static files, at the given path.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface javax.portlet.PortletResponse

addProperty, setProperty

 

Field Detail

invocation

protected final PortletInvocation invocation

.

---

preq

protected final PortletRequestImpl preq

.

Constructor Detail

PortletResponseImpl

protected PortletResponseImpl(PortletInvocation invocation,
                              PortletRequestImpl preq)

Method Detail

encodeURL

public java.lang.String encodeURL(java.lang.String url)

Description copied from interface: PortletResponse

Returns the encoded URL of the resource, like servlets, JSPs, images and other static files, at the given path.

Some portal/portlet-container implementation may require those URLs to contain implementation specific data encoded in it. Because of that, portlets should use this method to create such URLs.

The encodeURL method may include the session ID and other portal/portlet-container specific information into the URL. If encoding is not needed, it returns the URL unchanged.

Specified by:

encodeURL in interface PortletResponse

Parameters:

url - the URI path to the resource. This must be either an absolute URL (e.g. http://my.co/myportal/mywebap/myfolder/myresource.gif) or a full path URI (e.g. /myportal/mywebap/myfolder/myresource.gif).

Returns:

the encoded resource URL as string

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---