sae/api/Utils.java

	Utils.java revision 0f14c5266d32ed727cd64ba10f2d2da0ed623a41
af062818b47340eef15700d2f0211576ba3506eevboxsync/**
af062818b47340eef15700d2f0211576ba3506eevboxsync * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
af062818b47340eef15700d2f0211576ba3506eevboxsync *
af062818b47340eef15700d2f0211576ba3506eevboxsync * Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
af062818b47340eef15700d2f0211576ba3506eevboxsync *
af062818b47340eef15700d2f0211576ba3506eevboxsync * The contents of this file are subject to the terms
af062818b47340eef15700d2f0211576ba3506eevboxsync * of the Common Development and Distribution License
af062818b47340eef15700d2f0211576ba3506eevboxsync * (the License). You may not use this file except in
af062818b47340eef15700d2f0211576ba3506eevboxsync * compliance with the License.
af062818b47340eef15700d2f0211576ba3506eevboxsync *
af062818b47340eef15700d2f0211576ba3506eevboxsync * You can obtain a copy of the License at
af062818b47340eef15700d2f0211576ba3506eevboxsync * https://opensso.dev.java.net/public/CDDLv1.0.html or
af062818b47340eef15700d2f0211576ba3506eevboxsync * opensso/legal/CDDLv1.0.txt
af062818b47340eef15700d2f0211576ba3506eevboxsync * See the License for the specific language governing
af062818b47340eef15700d2f0211576ba3506eevboxsync * permission and limitations under the License.
af062818b47340eef15700d2f0211576ba3506eevboxsync *
af062818b47340eef15700d2f0211576ba3506eevboxsync * When distributing Covered Code, include this CDDL
af062818b47340eef15700d2f0211576ba3506eevboxsync * Header Notice in each file and include the License file
af062818b47340eef15700d2f0211576ba3506eevboxsync * at opensso/legal/CDDLv1.0.txt.
af062818b47340eef15700d2f0211576ba3506eevboxsync * If applicable, add the following below the CDDL Header,
af062818b47340eef15700d2f0211576ba3506eevboxsync * with the fields enclosed by brackets [] replaced by
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * your own identifying information:
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * "Portions Copyrighted [year] [name of copyright owner]"
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync *
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * $Id: Utils.java,v 1.4 2008/11/10 22:57:00 veiming Exp $
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync *
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * Portions Copyrighted 2013-2015 ForgeRock AS.
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync */
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsyncpackage com.sun.identity.sae.api;
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsyncimport org.owasp.esapi.ESAPI;
af062818b47340eef15700d2f0211576ba3506eevboxsyncimport javax.servlet.http.HttpServletResponse;
af062818b47340eef15700d2f0211576ba3506eevboxsyncimport javax.servlet.http.HttpServletRequest;
af062818b47340eef15700d2f0211576ba3506eevboxsyncimport java.io.PrintWriter;
af062818b47340eef15700d2f0211576ba3506eevboxsyncimport java.net.URLEncoder;
af062818b47340eef15700d2f0211576ba3506eevboxsyncimport java.util.Map;
af062818b47340eef15700d2f0211576ba3506eevboxsyncimport java.util.Iterator;
af062818b47340eef15700d2f0211576ba3506eevboxsyncimport java.util.Enumeration;
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync/**
af062818b47340eef15700d2f0211576ba3506eevboxsync  * Util class to implement simple Http request/response transactions.
af062818b47340eef15700d2f0211576ba3506eevboxsync  */
af062818b47340eef15700d2f0211576ba3506eevboxsyncpublic class Utils
af062818b47340eef15700d2f0211576ba3506eevboxsync{
af062818b47340eef15700d2f0211576ba3506eevboxsync    /**
af062818b47340eef15700d2f0211576ba3506eevboxsync      * Http POST
af062818b47340eef15700d2f0211576ba3506eevboxsync      */
af062818b47340eef15700d2f0211576ba3506eevboxsync    public static final String POST = "POST";
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync    /**
af062818b47340eef15700d2f0211576ba3506eevboxsync      * Http GET
af062818b47340eef15700d2f0211576ba3506eevboxsync      */
af062818b47340eef15700d2f0211576ba3506eevboxsync    public static final String GET = "GET";
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync    /**
af062818b47340eef15700d2f0211576ba3506eevboxsync     * Redirects to <code>redirectUrl</code> as a GET or a POST
af062818b47340eef15700d2f0211576ba3506eevboxsync     *  based on <code>action</code> parameter provided.
af062818b47340eef15700d2f0211576ba3506eevboxsync     *  in case of POST all params need to be specified in <code>pmap</code>
af062818b47340eef15700d2f0211576ba3506eevboxsync     *  parameter.
af062818b47340eef15700d2f0211576ba3506eevboxsync     *
af062818b47340eef15700d2f0211576ba3506eevboxsync     *  @param hres HttpSevletResponse to be used for the redirect
af062818b47340eef15700d2f0211576ba3506eevboxsync     *  @param out the print writer for writing out presentation
af062818b47340eef15700d2f0211576ba3506eevboxsync     *  @param redirectUrl URL to redirect to.
af062818b47340eef15700d2f0211576ba3506eevboxsync     *  @param pmap  http parameters to be sent as part of the redirect
af062818b47340eef15700d2f0211576ba3506eevboxsync     *  @param action http action to be executed : GET or POST
af062818b47340eef15700d2f0211576ba3506eevboxsync     */
af062818b47340eef15700d2f0211576ba3506eevboxsync    public static void redirect(HttpServletResponse hres, PrintWriter out, String redirectUrl,
af062818b47340eef15700d2f0211576ba3506eevboxsync           Map pmap, String action)
af062818b47340eef15700d2f0211576ba3506eevboxsync       throws Exception
af062818b47340eef15700d2f0211576ba3506eevboxsync    {
af062818b47340eef15700d2f0211576ba3506eevboxsync        if (action.equals("GET")) {
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync             StringBuilder buf = null;
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync             if (pmap != null) {
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync                 // Put it all together in query part of Url
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync                 String query = queryStringFromMap(pmap);
040b4a09341f574825386333398110f4db3e1e51vboxsync                 buf = new StringBuilder();
040b4a09341f574825386333398110f4db3e1e51vboxsync                 buf.append(redirectUrl);
114410893548b9522c46fdcbd8f63385eb8bfb68vboxsync                 if (!redirectUrl.contains("?")) {
040b4a09341f574825386333398110f4db3e1e51vboxsync                     buf.append("?");
114410893548b9522c46fdcbd8f63385eb8bfb68vboxsync                 }
040b4a09341f574825386333398110f4db3e1e51vboxsync                 buf.append(query);
114410893548b9522c46fdcbd8f63385eb8bfb68vboxsync             }
040b4a09341f574825386333398110f4db3e1e51vboxsync             String finalRedirectUrl = redirectUrl;
114410893548b9522c46fdcbd8f63385eb8bfb68vboxsync             if (buf != null)
040b4a09341f574825386333398110f4db3e1e51vboxsync                 finalRedirectUrl = buf.toString();
114410893548b9522c46fdcbd8f63385eb8bfb68vboxsync             hres.sendRedirect(finalRedirectUrl);
af062818b47340eef15700d2f0211576ba3506eevboxsync        } else {
af062818b47340eef15700d2f0211576ba3506eevboxsync             String html = formFromMap(redirectUrl, pmap, true);
af062818b47340eef15700d2f0211576ba3506eevboxsync             out.write(html);
af062818b47340eef15700d2f0211576ba3506eevboxsync        }
af062818b47340eef15700d2f0211576ba3506eevboxsync    }
af062818b47340eef15700d2f0211576ba3506eevboxsync    /**
af062818b47340eef15700d2f0211576ba3506eevboxsync      * Generates a query string from the parameters in the request.
af062818b47340eef15700d2f0211576ba3506eevboxsync      * @param request http request to pick params from.
af062818b47340eef15700d2f0211576ba3506eevboxsync      * @return query string
af062818b47340eef15700d2f0211576ba3506eevboxsync      */
af062818b47340eef15700d2f0211576ba3506eevboxsync    public static String queryStringFromRequest(HttpServletRequest request)
af062818b47340eef15700d2f0211576ba3506eevboxsync    {
af062818b47340eef15700d2f0211576ba3506eevboxsync        Enumeration en = request.getParameterNames();
af062818b47340eef15700d2f0211576ba3506eevboxsync        StringBuilder buf = new StringBuilder();
af062818b47340eef15700d2f0211576ba3506eevboxsync        boolean priorparam = false;
af062818b47340eef15700d2f0211576ba3506eevboxsync        while (en.hasMoreElements()) {
af062818b47340eef15700d2f0211576ba3506eevboxsync            String name = (String) en.nextElement();
af062818b47340eef15700d2f0211576ba3506eevboxsync            String val = request.getParameter(name);
af062818b47340eef15700d2f0211576ba3506eevboxsync            if (priorparam)
af062818b47340eef15700d2f0211576ba3506eevboxsync                buf.append("&");
af062818b47340eef15700d2f0211576ba3506eevboxsync            buf.append(name).append("=").append(val);
af062818b47340eef15700d2f0211576ba3506eevboxsync            priorparam = true;
af062818b47340eef15700d2f0211576ba3506eevboxsync        }
af062818b47340eef15700d2f0211576ba3506eevboxsync        return buf.toString();
af062818b47340eef15700d2f0211576ba3506eevboxsync    }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync    /**
af062818b47340eef15700d2f0211576ba3506eevboxsync      * Generates a query string from the a <code>Map</code>.
af062818b47340eef15700d2f0211576ba3506eevboxsync      * @param pmap params to be added to the query string.
af062818b47340eef15700d2f0211576ba3506eevboxsync      * @return query string
af062818b47340eef15700d2f0211576ba3506eevboxsync      */
af062818b47340eef15700d2f0211576ba3506eevboxsync    public static String queryStringFromMap(Map pmap)
af062818b47340eef15700d2f0211576ba3506eevboxsync    {
af062818b47340eef15700d2f0211576ba3506eevboxsync        Iterator iter = pmap.keySet().iterator();
af062818b47340eef15700d2f0211576ba3506eevboxsync        StringBuilder buf = new StringBuilder();
af062818b47340eef15700d2f0211576ba3506eevboxsync        boolean priorparam = false;
af062818b47340eef15700d2f0211576ba3506eevboxsync        while (iter.hasNext()) {
af062818b47340eef15700d2f0211576ba3506eevboxsync            String name = (String) iter.next();
af062818b47340eef15700d2f0211576ba3506eevboxsync            String val = (String) pmap.get(name);
af062818b47340eef15700d2f0211576ba3506eevboxsync            if (priorparam)
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync                buf.append("&");
af062818b47340eef15700d2f0211576ba3506eevboxsync            buf.append(name).append("=").append(URLEncoder.encode(val));
af062818b47340eef15700d2f0211576ba3506eevboxsync            priorparam = true;
af062818b47340eef15700d2f0211576ba3506eevboxsync        }
af062818b47340eef15700d2f0211576ba3506eevboxsync        return buf.toString();
af062818b47340eef15700d2f0211576ba3506eevboxsync    }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync    /**
af062818b47340eef15700d2f0211576ba3506eevboxsync      * Generates a html hidden form to acccomplish a auto POST from the browser
af062818b47340eef15700d2f0211576ba3506eevboxsync      * Form is assigned an id=saeform
af062818b47340eef15700d2f0211576ba3506eevboxsync      * @param redirectUrl URL to post teh form to.
af062818b47340eef15700d2f0211576ba3506eevboxsync      * @param pmap parameters to be sent in the POST
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync      * @param addAutoSubmit adds html and javascript to autosubmit form
af062818b47340eef15700d2f0211576ba3506eevboxsync      * @return html code
af062818b47340eef15700d2f0211576ba3506eevboxsync      */
af062818b47340eef15700d2f0211576ba3506eevboxsync    public static String formFromMap(String redirectUrl,  Map pmap,
af062818b47340eef15700d2f0211576ba3506eevboxsync            boolean addAutoSubmit)
af062818b47340eef15700d2f0211576ba3506eevboxsync    {
af062818b47340eef15700d2f0211576ba3506eevboxsync        StringBuilder buf = new StringBuilder();
af062818b47340eef15700d2f0211576ba3506eevboxsync        if (addAutoSubmit) {
af062818b47340eef15700d2f0211576ba3506eevboxsync            buf.append("<HTML><HEAD><TITLE>SAE POST</TITLE></HEAD>");
af062818b47340eef15700d2f0211576ba3506eevboxsync            buf.append("<BODY Onload=\"document.forms[0].submit()\">");
af062818b47340eef15700d2f0211576ba3506eevboxsync        }
af062818b47340eef15700d2f0211576ba3506eevboxsync        buf.append("<FORM id=\"saeform\" METHOD=\"POST\" ACTION=\"").append(redirectUrl).append("\">");
af062818b47340eef15700d2f0211576ba3506eevboxsync        for (Object name : pmap.keySet()) {
af062818b47340eef15700d2f0211576ba3506eevboxsync            String val = (String) pmap.get(name);
af062818b47340eef15700d2f0211576ba3506eevboxsync            buf.append("<INPUT TYPE=\"HIDDEN\" NAME=\"").append(name).append("\" VALUE=\"");
af062818b47340eef15700d2f0211576ba3506eevboxsync            buf.append(ESAPI.encoder().encodeForHTML(val)).append("\">");
af062818b47340eef15700d2f0211576ba3506eevboxsync        }
af062818b47340eef15700d2f0211576ba3506eevboxsync        buf.append("</FORM>");
af062818b47340eef15700d2f0211576ba3506eevboxsync        if (addAutoSubmit) {
af062818b47340eef15700d2f0211576ba3506eevboxsync            buf.append("</BODY></HTML>");
af062818b47340eef15700d2f0211576ba3506eevboxsync        }
af062818b47340eef15700d2f0211576ba3506eevboxsync        return buf.toString();
af062818b47340eef15700d2f0211576ba3506eevboxsync    }
af062818b47340eef15700d2f0211576ba3506eevboxsync
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync}
af062818b47340eef15700d2f0211576ba3506eevboxsync