Package javax.portlet

Interface ActionResponse

    • Method Detail

      • sendRedirect

        void sendRedirect​(java.lang.String location)
                   throws java.io.IOException
        Instructs the portlet container to send a redirect response to the client using the specified redirect location URL.

        This method only accepts 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). If required, the portlet container may encode the given URL before the redirection is issued to the client.

        The sendRedirect method can not be invoked after any of the following methods of the ActionResponse interface has been called:

        • setPortletMode
        • setWindowState
        • setRenderParameter
        • setRenderParameters
        • removePublicRenderParamter
        Parameters:
        location - the redirect location URL
        Throws:
        java.io.IOException - if an input or output exception occurs.
        java.lang.IllegalArgumentException - if a relative path URL is given
        java.lang.IllegalStateException - if the method is invoked after any of above mentioned methods of the ActionResponse interface has been called.
      • sendRedirect

        void sendRedirect​(java.lang.String location,
                          java.lang.String renderUrlParamName)
                   throws java.io.IOException
        Instructs the portlet container to send a redirect response to the client using the specified redirect location URL and encode a render URL as parameter on the redirect URL.

        This method only accepts 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). If required, the portlet container may encode the given URL before the redirection is issued to the client.

        The portlet container will attach a render URL with the currently set portlet mode, window state and render parameters on the ActionResponse and the current public render parameters. The attached URL will be available as query parameter value under the key provided with the renderUrlParamName parameter.

        New values for

        • setPortletMode
        • setWindowState
        • setRenderParameter
        • setRenderParameters
        are only used for creating the render URL and not remembered after the redirect is issued.
        Parameters:
        location - the redirect location URL
        renderUrlParamName - name of the query parameter under which the portlet container should store a render URL to this portlet
        Throws:
        java.io.IOException - if an input or output exception occurs.
        java.lang.IllegalArgumentException - if a relative path URL is given
        Since:
        2.0