/* | |
* The Apache Software License, Version 1.1 | |
* | |
* Copyright (c) 2003 The Apache Software Foundation. All rights | |
* reserved. | |
* | |
* Redistribution and use in source and binary forms, with or without | |
* modification, are permitted provided that the following conditions | |
* are met: | |
* | |
* 1. Redistributions of source code must retain the above copyright | |
* notice, this list of conditions and the following disclaimer. | |
* | |
* 2. Redistributions in binary form must reproduce the above copyright | |
* notice, this list of conditions and the following disclaimer in | |
* the documentation and/or other materials provided with the | |
* distribution. | |
* | |
* 3. The end-user documentation included with the redistribution, if | |
* any, must include the following acknowlegement: | |
* "This product includes software developed by the | |
* Apache Software Foundation (http://www.apache.org/)." | |
* Alternately, this acknowlegement may appear in the software itself, | |
* if and wherever such third-party acknowlegements normally appear. | |
* | |
* 4. The names "The Jakarta Project", "Pluto", and "Apache Software | |
* Foundation" must not be used to endorse or promote products derived | |
* from this software without prior written permission. For written | |
* permission, please contact apache@apache.org. | |
* | |
* 5. Products derived from this software may not be called "Apache" | |
* nor may "Apache" appear in their names without prior written | |
* permission of the Apache Group. | |
* | |
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED | |
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES | |
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR | |
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF | |
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | |
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | |
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT | |
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
* SUCH DAMAGE. | |
* ==================================================================== | |
* | |
* This software consists of voluntary contributions made by many | |
* individuals on behalf of the Apache Software Foundation. For more | |
* information on the Apache Software Foundation, please see | |
* <http://www.apache.org/>. | |
* | |
* ==================================================================== | |
* | |
* 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 <CODE>PortletURL</CODE> interface represents a URL | |
* that reference the portlet itself. | |
* <p> | |
* A PortletURL is created through the <CODE>RenderResponse</CODE>. | |
* Parameters, a portlet mode, a window state and a security level | |
* can be added to <CODE>PortletURL</CODE> objects. The PortletURL | |
* must be converted to a String in order to embed it into | |
* the markup generated by the portlet. | |
* <P> | |
* There are two types of PortletURLs: | |
* <ul> | |
* <li>Action URLs, they are created with <CODE>RenderResponse.createActionURL</CODE>, and | |
* trigger an action request followed by a render request. | |
* <li>Render URLs, they are created with <CODE>RenderResponse.createRenderURL</CODE>, and | |
* trigger a render request. | |
* </ul> | |
* <p> | |
* The string reprensentation of a PortletURL does not need to be a valid | |
* URL at the time the portlet is generating its content. It may contain | |
* special tokens that will be converted to a valid URL, by the portal, | |
* before the content is returned to the client. | |
*/ | |
public interface PortletURL | |
{ | |
/** | |
* Indicates the window state the portlet should be in, if this | |
* portlet URL triggers a request. | |
* <p> | |
* A URL can not have more than one window state attached to it. | |
* If more than one window state is set only the last one set | |
* is attached to the URL. | |
* | |
* @param windowState | |
* the portlet window state | |
* | |
* @exception WindowStateException | |
* if the portlet cannot switch to this state, | |
* because the portal does not support this state, the portlet has not | |
* declared in its deployment descriptor that it supports this state, or the current | |
* user is not allowed to switch to this state. | |
* The <code>PortletRequest.isWindowStateAllowed()</code> method can be used | |
* to check if the portlet can set a given window state. | |
* @see PortletRequest#isWindowStateAllowed | |
*/ | |
public void setWindowState (WindowState windowState) | |
throws WindowStateException; | |
/** | |
* Indicates the portlet mode the portlet must be in, if this | |
* portlet URL triggers a request. | |
* <p> | |
* A URL can not have more than one portlet mode attached to it. | |
* If more than one portlet mode is set only the last one set | |
* is attached to the URL. | |
* | |
* @param portletMode | |
* the portlet mode | |
* | |
* @exception PortletModeException | |
* if the portlet cannot switch to this mode, | |
* because the portal does not support this mode, the portlet has not | |
* declared in its deployment descriptor that it supports this mode for the current markup, | |
* or the current user is not allowed to switch to this mode. | |
* The <code>PortletRequest.isPortletModeAllowed()</code> method can be used | |
* to check if the portlet can set a given portlet mode. | |
* @see PortletRequest#isPortletModeAllowed | |
*/ | |
public void setPortletMode (PortletMode portletMode) | |
throws PortletModeException; | |
/** | |
* Sets the given String parameter to this URL. | |
* <p> | |
* This method replaces all parameters with the given key. | |
* <p> | |
* The <code>PortletURL</code> implementation 'x-www-form-urlencoded' encodes | |
* all parameter names and values. Developers should not encode them. | |
* <p> | |
* A portlet container may prefix the attribute names internally | |
* in order to preserve a unique namespace for the portlet. | |
* | |
* @param name | |
* the parameter name | |
* @param value | |
* the parameter value | |
* | |
* @exception java.lang.IllegalArgumentException | |
* if name or value are <code>null</code>. | |
*/ | |
public void setParameter (String name, String value); | |
/** | |
* Sets the given String array parameter to this URL. | |
* <p> | |
* This method replaces all parameters with the given key. | |
* <p> | |
* The <code>PortletURL</code> implementation 'x-www-form-urlencoded' encodes | |
* all parameter names and values. Developers should not encode them. | |
* <p> | |
* A portlet container may prefix the attribute names internally | |
* in order to preserve a unique namespace for the portlet. | |
* | |
* @param name | |
* the parameter name | |
* @param values | |
* the parameter values | |
* | |
* @exception java.lang.IllegalArgumentException | |
* if name or values are <code>null</code>. | |
*/ | |
public void setParameter (String name, String[] values); | |
/** | |
* Sets a parameter map for this URL. | |
* <p> | |
* All previously set parameters are cleared. | |
* <p> | |
* The <code>PortletURL</code> implementation 'x-www-form-urlencoded' encodes | |
* all parameter names and values. Developers should not encode them. | |
* <p> | |
* A portlet container may prefix the attribute names internally, | |
* in order to preserve a unique namespace for the portlet. | |
* | |
* @param parameters Map containing parameter names for | |
* the render phase as | |
* keys and parameter values as map | |
* values. The keys in the parameter | |
* map must be of type String. The values | |
* in the parameter map must be of type | |
* String array (<code>String[]</code>). | |
* | |
* @exception java.lang.IllegalArgumentException | |
* if parameters is <code>null</code>, if | |
* any of the key/values in the Map are <code>null</code>, | |
* if any of the keys is not a String, or if any of | |
* the values is not a String array. | |
*/ | |
public void setParameters(java.util.Map parameters); | |
/** | |
* Indicated the security setting for this URL. | |
* <p> | |
* Secure set to <code>true</code> indicates that the portlet requests | |
* a secure connection between the client and the portlet window for | |
* this URL. Secure set to <code>false</code> indicates that the portlet | |
* does not need a secure connection for this URL. If the security is not | |
* set for a URL, it will stay the same as the current request. | |
* | |
* @param secure true, if portlet requests to have a secure connection | |
* between its portlet window and the client; false, if | |
* the portlet does not require a secure connection. | |
* | |
* @throws PortletSecurityException if the run-time environment does | |
* not support the indicated setting | |
*/ | |
public void setSecure (boolean secure) throws PortletSecurityException; | |
/** | |
* Returns the portlet URL string representation to be embedded in the | |
* markup.<br> | |
* Note that the returned String may not be a valid URL, as it may | |
* be rewritten by the portal/portlet-container before returning the | |
* markup to the client. | |
* | |
* @return the encoded URL as a string | |
*/ | |
public String toString (); | |
} |