Return-Path: Delivered-To: apmail-portals-pluto-scm-archive@www.apache.org Received: (qmail 20501 invoked from network); 2 Nov 2008 22:20:30 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 2 Nov 2008 22:20:30 -0000 Received: (qmail 92379 invoked by uid 500); 2 Nov 2008 22:20:36 -0000 Delivered-To: apmail-portals-pluto-scm-archive@portals.apache.org Received: (qmail 92356 invoked by uid 500); 2 Nov 2008 22:20:36 -0000 Mailing-List: contact pluto-scm-help@portals.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: List-Id: Delivered-To: mailing list pluto-scm@portals.apache.org Received: (qmail 92347 invoked by uid 99); 2 Nov 2008 22:20:36 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 02 Nov 2008 14:20:36 -0800 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 02 Nov 2008 22:19:24 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 8496F2389896; Sun, 2 Nov 2008 14:19:12 -0800 (PST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r709960 [17/23] - in /portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs: ./ index-files/ javax/portlet/ javax/portlet/class-use/ javax/portlet/filter/ javax/portlet/listener/ Date: Sun, 02 Nov 2008 22:19:09 -0000 To: pluto-scm@portals.apache.org From: ate@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20081102221912.8496F2389896@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletRequestDispatcher.html URL: http://svn.apache.org/viewvc/portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletRequestDispatcher.html?rev=709960&view=auto ============================================================================== --- portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletRequestDispatcher.html (added) +++ portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletRequestDispatcher.html Sun Nov 2 14:19:07 2008 @@ -0,0 +1,324 @@ + + + + + + +PortletRequestDispatcher + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +javax.portlet +
+Interface PortletRequestDispatcher

+
+
+
public interface PortletRequestDispatcher
+ + +

+The 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. The portlet + container creates the PortletRequestDispatcher object, which + is used as a wrapper around a server resource located at a particular path or + given by a particular name. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidforward(PortletRequest request, + PortletResponse response) + +
+          Forwards a portlet request from a portlet to another resource (servlet, JSP file, or HTML file) + on the server.
+ voidinclude(PortletRequest request, + PortletResponse response) + +
+          Includes the content of a resource (servlet, JSP page, HTML file) in the + response.
+ voidinclude(RenderRequest request, + RenderResponse response) + +
+          Includes the content of a resource (servlet, JSP page, HTML file) in the + response.
+  +

+ + + + + + + + +
+Method Detail
+ +

+include

+
+void include(RenderRequest request,
+             RenderResponse response)
+             throws PortletException,
+                    java.io.IOException
+
+
Includes the content of a resource (servlet, JSP page, HTML file) in the + response. In essence, this method enables programmatic server-side + includes. +

+ The included servlet cannot set or change the response status code or set + headers; any attempt to make a change is ignored. +

+ This method is kept in order to provide backward compatibility with + version 1.0. Please use include(PortletRequest, PortletResponse) instead + of this method. +

+

+
Parameters:
request - a RenderRequest object that contains the client + request. Must be either the render request passed to the + portlet in render or a wrapped version of this + render request.
response - a RenderResponse object that contains the render + response. Must be either the render response passed to the + portlet in render or a wrapped version of this + render response. +
Throws: +
PortletException - if the included resource throws a ServletException, or + other exceptions that are not Runtime- or IOExceptions. +
java.io.IOException - if the included resource throws this exception
+
+
+
+ +

+include

+
+void include(PortletRequest request,
+             PortletResponse response)
+             throws PortletException,
+                    java.io.IOException
+
+
Includes the content of a resource (servlet, JSP page, HTML file) in the + response. In essence, this method enables programmatic server-side + includes. +

+ The included servlet cannot set or change the response status code or set + headers; any attempt to make a change is ignored. +

+

+
Parameters:
request - a PortletRequest object that contains the portlet + request. Must be either the original request passed to the + portlet or a wrapped version of this request.
response - a PortletResponse object that contains the portlet + response. Must be either the portlet response passed to the + portlet or a wrapped version of this response. +
Throws: +
PortletException - if the included resource throws a ServletException, or + other exceptions that are not Runtime- or IOExceptions. +
java.io.IOException - if the included resource throws this exception
Since:
+
2.0
+
+
+
+
+ +

+forward

+
+void forward(PortletRequest request,
+             PortletResponse response)
+             throws PortletException,
+                    java.io.IOException
+
+
Forwards a portlet request from a portlet to another resource (servlet, JSP file, or HTML file) + on the server. This method allows the portlet to do preliminary processing of a + request and another resource to generate the response. +

+ The forward method should be called before the response has been + committed to the portlet container (before response body output has been flushed). + If the response already has been committed, this method throws an + IllegalStateException. Uncommitted output in the response buffer + is automatically cleared before the forward. +

+ The request and response parameters must be either the same objects as were passed to + the calling portlet or be wrapped versions of these. +

+

+
Parameters:
request - a request object that represents the request to the + portlet
response - a reponse object that contains the portlet response +
Throws: +
PortletException - if the included resource throws a ServletException, or + other exceptions that are not Runtime- or IOExceptions. +
java.io.IOException - if the included resource throws this exception +
java.lang.IllegalStateException - if the response was already committed
Since:
+
2.0
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + Propchange: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletRequestDispatcher.html ------------------------------------------------------------------------------ svn:keywords = Id Added: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletResponse.html URL: http://svn.apache.org/viewvc/portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletResponse.html?rev=709960&view=auto ============================================================================== --- portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletResponse.html (added) +++ portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletResponse.html Sun Nov 2 14:19:07 2008 @@ -0,0 +1,447 @@ + + + + + + +PortletResponse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +javax.portlet +
+Interface PortletResponse

+
+
All Known Subinterfaces:
ActionResponse, EventResponse, MimeResponse, RenderResponse, ResourceResponse, StateAwareResponse
+
+
+
All Known Implementing Classes:
ActionResponseWrapper, EventResponseWrapper, PortletResponseWrapper, RenderResponseWrapper, ResourceResponseWrapper
+
+
+
+
public interface PortletResponse
+ + +

+The PortletResponse defines the base interface to assist a + portlet in creating and sending a response to the client. The portlet + container uses specialized versions of this interface when invoking a + portlet. + The portlet container creates these objects and passes them as arguments to + the portlet's processAction, processEvent, serveResource and render methods. +

+ +

+

+
See Also:
ActionResponse, +RenderResponse, +EventResponse, +ResourceResponse
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddProperty(javax.servlet.http.Cookie cookie) + +
+          Adds a HTTP Cookie property to the response.
+ The portlet should note that the cookie may not make + it to the client, but may be stored at the portal.
+ voidaddProperty(java.lang.String key, + org.w3c.dom.Element element) + +
+          Adds an XML DOM element property to the response.
+ voidaddProperty(java.lang.String key, + java.lang.String value) + +
+          Adds a String property to an existing key to be returned to the portal.
+ org.w3c.dom.ElementcreateElement(java.lang.String tagName) + +
+          Creates an element of the type specified to be used in the + addProperty(String,Element) method.
+ java.lang.StringencodeURL(java.lang.String path) + +
+          Returns the encoded URL of the resource, like servlets, JSPs, images and + other static files, at the given path.
+ java.lang.StringgetNamespace() + +
+          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.
+ voidsetProperty(java.lang.String key, + java.lang.String value) + +
+          Sets a String property to be returned to the portal.
+  +

+ + + + + + + + +
+Method Detail
+ +

+addProperty

+
+void addProperty(java.lang.String key,
+                 java.lang.String value)
+
+
Adds a String property to an existing key to be returned to the portal. + If there are no property values already associated with the key, + a new key is created. +

+ This method allows response properties to have multiple values. +

+ Response properties can be viewed as header values set for the portal application. + If these header values are intended to be transmitted to the client they should be + set before the response is committed. +

+

+
Parameters:
key - the key of the property to be returned to the portal
value - the value of the property to be returned to the portal +
Throws: +
java.lang.IllegalArgumentException - if key is null.
+
+
+
+ +

+setProperty

+
+void setProperty(java.lang.String key,
+                 java.lang.String value)
+
+
Sets a String property to be returned to the portal. +

+ Response properties can be viewed as header values set for the portal application. + If these header values are intended to be transmitted to the client they should be + set before the response is committed. +

+ This method resets all properties previously added with the same key. +

+

+
Parameters:
key - the key of the property to be returned to the portal
value - the value of the property to be returned to the portal +
Throws: +
java.lang.IllegalArgumentException - if key is null.
+
+
+
+ +

+encodeURL

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

+ Portlets should encode all resource URLs pointing to resources in the + portlet application via this method in order to ensure that they get + served via the portal application. +

+ 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. +

+ Portlet developer should be aware that the returned URL might not be a well formed + URL but a special token at the time the portlet is generating its content. + Thus portlets should not add additional parameters on the resulting URL or + expect to be able to parse the URL. As a result, the outcome of the encodeURL + call may be different than calling encodeURL in the servlet world. +

+

+
Parameters:
path - 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, may not be a valid URL +
Throws: +
java.lang.IllegalArgumentException - if path doesn't have a leading slash or is not an absolute + URL
+
+
+
+ +

+getNamespace

+
+java.lang.String getNamespace()
+
+
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. +

+ The namespace value must be constant for the lifetime of the portlet + window. +

+

+ +
Returns:
the namespace
+
+
+
+ +

+addProperty

+
+void addProperty(javax.servlet.http.Cookie cookie)
+
+
Adds a HTTP Cookie property to the response.
+ The portlet should note that the cookie may not make + it to the client, but may be stored at the portal. +

+ This method allows response properties to have multiple cookies. +

+

+

+
Parameters:
cookie - the cookie to be added to the response +
Throws: +
java.lang.IllegalArgumentException - if cookie is null.
Since:
+
2.0
+
+
+
+
+ +

+addProperty

+
+void addProperty(java.lang.String key,
+                 org.w3c.dom.Element element)
+
+
Adds an XML DOM element property to the response. +

+ If a DOM element with the provided key already exists + the provided element will be stored in addition to the + existing element under the same key. +

+ If the element is null the key is removed from + the response. +

+ Response XML DOM element properties can be viewed as + additional response document sections + set for the portal application. + If these header values are intended to be transmitted to the client they should be + set before the response is committed. +

+

+
Parameters:
key - the key of the property to be returned to the portal
element - the XML DOM element to be added to the response +
Throws: +
java.lang.IllegalArgumentException - if key is null.
Since:
+
2.0
+
+
+
+
+ +

+createElement

+
+org.w3c.dom.Element createElement(java.lang.String tagName)
+                                  throws org.w3c.dom.DOMException
+
+
Creates an element of the type specified to be used in the + addProperty(String,Element) method. +

+

+
Parameters:
tagName - name of the element type to instantiate +
Returns:
A new Element object with the nodeName attribute set to tagName, + and localName, prefix, and namespaceURI set to null. +
Throws: +
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name + contains an illegal character.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + Propchange: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletResponse.html ------------------------------------------------------------------------------ svn:keywords = Id Added: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletSecurityException.html URL: http://svn.apache.org/viewvc/portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletSecurityException.html?rev=709960&view=auto ============================================================================== --- portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletSecurityException.html (added) +++ portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletSecurityException.html Sun Nov 2 14:19:07 2008 @@ -0,0 +1,304 @@ + + + + + + +PortletSecurityException + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +javax.portlet +
+Class PortletSecurityException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by javax.portlet.PortletException
+              extended by javax.portlet.PortletSecurityException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class PortletSecurityException
extends PortletException
+ + +

+A portlet should throw a PortletSecurityException + when a call fails because of security reasons.
+ Additionally it can be thrown by the portal/portlet-container. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + +
+Constructor Summary
PortletSecurityException(java.lang.String text) + +
+          Constructs a new security exception with the given text.
PortletSecurityException(java.lang.String text, + java.lang.Throwable cause) + +
+          Constructs a new portlet security exception when the portlet needs to do + the following: + + throw an exception + include a message about the "root cause" that interfered + with its normal operation + include a description message +
PortletSecurityException(java.lang.Throwable cause) + +
+          Constructs a new portlet security exception when the portlet needs to throw an + exception.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PortletSecurityException

+
+public PortletSecurityException(java.lang.String text)
+
+
Constructs a new security exception with the given text. The + portlet container may use the text write it to a log. +

+

+
Parameters:
text - the exception text
+
+
+ +

+PortletSecurityException

+
+public PortletSecurityException(java.lang.String text,
+                                java.lang.Throwable cause)
+
+
Constructs a new portlet security exception when the portlet needs to do + the following: +
    + throw an exception +
  • include a message about the "root cause" that interfered + with its normal operation +
  • include a description message +
+

+

+
Parameters:
text - the exception text
cause - the root cause
+
+
+ +

+PortletSecurityException

+
+public PortletSecurityException(java.lang.Throwable cause)
+
+
Constructs a new portlet security exception when the portlet needs to throw an + exception. The exception message is based on the localized message + of the underlying exception. +

+

+
Parameters:
cause - the root cause
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + Propchange: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/PortletSecurityException.html ------------------------------------------------------------------------------ svn:keywords = Id