portletrequest.java

GridSphere 门户 提供一个基于 portlet 的高级开放源代码门户。GridSphere 是在欧盟提供基金的 GridLab 项目下开发的

    public boolean isUserInRole(java.lang.String role);

    /**
     * Returns the value of the named attribute as an <code>Object</code>,
     * or <code>null</code> if no attribute of the given name exists.
     * <p/>
     * Attribute names should follow the same conventions as package
     * names. This specification reserves names matching <code>java.*</code>,
     * and <code>javax.*</code>.
     * <p/>
     * In a distributed portlet web application the <code>Object</code>
     * needs to be serializable.
     *
     * @param name a <code>String</code> specifying the name of
     *             the attribute
     * @throws java.lang.IllegalArgumentException
     *          if name is <code>null</code>.
     * @return		an <code>Object</code> containing the value
     * of the attribute, or <code>null</code> if
     * the attribute does not exist.
     */
    public Object getAttribute(String name);

    /**
     * Returns an <code>Enumeration</code> containing the
     * names of the attributes available to this request.
     * This method returns an empty <code>Enumeration</code>
     * if the request has no attributes available to it.
     *
     * @return		an <code>Enumeration</code> of strings
     * containing the names
     * of the request attributes, or an empty
     * <code>Enumeration</code> if the request
     * has no attributes available to it.
     */
    public java.util.Enumeration getAttributeNames();

    /**
     * Returns the value of a request parameter as a <code>String</code>,
     * or <code>null</code> if the parameter does not exist. Request parameters
     * are extra information sent with the request. The returned parameter
     * are "x-www-form-urlencoded" decoded.
     * <p/>
     * Only parameters targeted to the current portlet are accessible.
     * <p/>
     * This method should only be used if the
     * parameter has only one value. If the parameter might have
     * more than one value, use {@link #getParameterValues}.
     * <p/>
     * If this method is used with a multivalued
     * parameter, the value returned is equal to the first value
     * in the array returned by <code>getParameterValues</code>.
     *
     * @param name a <code>String</code> specifying the
     *             name of the parameter
     * @throws java.lang.IllegalArgumentException
     *          if name is <code>null</code>.
     * @return		a <code>String</code> representing the
     * single value of the parameter
     * @see #getParameterValues
     */
    public String getParameter(String name);

    /**
     * Returns an <code>Enumeration</code> of <code>String</code>
     * objects containing the names of the parameters contained
     * in this request. If the request has
     * no parameters, the method returns an
     * empty <code>Enumeration</code>.
     * <p/>
     * Only parameters targeted to the current portlet are returned.
     *
     * @return		an <code>Enumeration</code> of <code>String</code>
     * objects, each <code>String</code> containing
     * the name of a request parameter; or an
     * empty <code>Enumeration</code> if the
     * request has no parameters.
     */
    public java.util.Enumeration getParameterNames();

    /**
     * Returns an array of <code>String</code> objects containing
     * all of the values the given request parameter has, or
     * <code>null</code> if the parameter does not exist.
     * The returned parameters are "x-www-form-urlencoded" decoded.
     * <p/>
     * If the parameter has a single value, the array has a length
     * of 1.
     *
     * @param name a <code>String</code> containing the name of
     *             the parameter the value of which is requested
     * @throws java.lang.IllegalArgumentException
     *          if name is <code>null</code>.
     * @return		an array of <code>String</code> objects
     * containing the parameter values.
     * @see		#getParameter
     */
    public String[] getParameterValues(String name);

    /**
     * Returns a <code>Map</code> of the parameters of this request.
     * Request parameters are extra information sent with the request.
     * The returned parameters are "x-www-form-urlencoded" decoded.
     * <p/>
     * The values in the returned <code>Map</code> are from type
     * String array (<code>String[]</code>).
     * <p/>
     * If no parameters exist this method returns an empty <code>Map</code>.
     *
     * @return an immutable <code>Map</code> containing parameter names as
     *         keys and parameter values as map values, or an empty <code>Map</code>
     *         if no parameters exist. The keys in the parameter
     *         map are of type String. The values in the parameter map are of type
     *         String array (<code>String[]</code>).
     */
    public java.util.Map getParameterMap();

    /**
     * Returns a boolean indicating whether this request was made
     * using a secure channel between client and the portal, such as HTTPS.
     *
     * @return true, if the request was made using a secure channel.
     */
    public boolean isSecure();

    /**
     * Stores an attribute in this request.
     * <p/>
     * <p>Attribute names should follow the same conventions as
     * package names. Names beginning with <code>java.*</code>,
     * <code>javax.*</code>, and <code>com.sun.*</code> are
     * reserved for use by Sun Microsystems.
     * <br> If the value passed into this method is <code>null</code>,
     * the effect is the same as calling {@link #removeAttribute}.
     *
     * @param name a <code>String</code> specifying
     *             the name of the attribute
     * @param o    the <code>Object</code> to be stored
     * @throws java.lang.IllegalArgumentException
     *          if name is <code>null</code>.
     */
    public void setAttribute(String name, Object o);


    /**
     * Removes an attribute from this request.  This method is not
     * generally needed, as attributes only persist as long as the request
     * is being handled.
     * <p/>
     * <p>Attribute names should follow the same conventions as
     * package names. Names beginning with <code>java.*</code>,
     * <code>javax.*</code>, and <code>com.sun.*</code> are
     * reserved for use by Sun Microsystems.
     *
     * @param name a <code>String</code> specifying
     *             the name of the attribute to be removed
     * @throws java.lang.IllegalArgumentException
     *          if name is <code>null</code>.
     */
    public void removeAttribute(String name);

    /**
     * Returns the session ID indicated in the client request.
     * This session ID may not be a valid one, it may be an old
     * one that has expired or has been invalidated.
     * If the client request
     * did not specify a session ID, this method returns
     * <code>null</code>.
     *
     * @return		a <code>String</code> specifying the session
     * ID, or <code>null</code> if the request did
     * not specify a session ID
     * @see		#isRequestedSessionIdValid
     */
    public String getRequestedSessionId();

    /**
     * Checks whether the requested session ID is still valid.
     *
     * @return			<code>true</code> if this
     * request has an id for a valid session
     * in the current session context;
     * <code>false</code> otherwise
     * @see			#getRequestedSessionId
     * @see			#getPortletSession
     */
    public boolean isRequestedSessionIdValid();

    /**
     * Returns the portal preferred content type for the response.
     * <p/>
     * The content type only includes the MIME type, not the
     * character set.
     * <p/>
     * Only content types that the portlet has defined in its
     * deployment descriptor are valid return values for
     * this method call. If the portlet has defined
     * <code>'*'</code> or <code>'* / *'</code> as supported content
     * types, these may also be valid return values.
     *
     * @return preferred MIME 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.
     * <p/>
     * The content type only includes the MIME type, not the
     * character set.
     * <p/>
     * Only content types that the portlet has defined in its
     * deployment descriptor are valid return values for
     * this method call. If the portlet has defined
     * <code>'*'</code> or <code>'* / *'</code> as supported content
     * types, these may also be valid return values.
     *
     * @return ordered list of MIME types for the response
     */
    public java.util.Enumeration getResponseContentTypes();


    /**
     * Returns the preferred Locale in which the portal will accept content.
     * The Locale may be based on the Accept-Language header of the client.
     *
     * @return the prefered Locale in which the portal will accept content.
     */
    public java.util.Locale getLocale();


    /**
     * Returns an Enumeration of Locale objects indicating, in decreasing
     * order starting with the preferred locale in which the portal will
     * accept content for this request.
     * The Locales may be based on the Accept-Language header of the client.
     *
     * @return an Enumeration of Locales, in decreasing order, in which
     *         the portal will accept content for this request
     */
    public java.util.Enumeration getLocales();


    /**
     * Returns the name of the scheme used to make this request.
     * For example, <code>http</code>, <code>https</code>, or <code>ftp</code>.
     * Different schemes have different rules for constructing URLs,
     * as noted in RFC 1738.
     *
     * @return		a <code>String</code> containing the name
     * of the scheme used to make this request
     */
    public String getScheme();


    /**
     * Returns the host name of the server that received the request.
     *
     * @return		a <code>String</code> containing the name
     * of the server to which the request was sent
     */
    public String getServerName();


    /**
     * Returns the port number on which this request was received.
     *
     * @return		an integer specifying the port number
     */
    public int getServerPort();

}