a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: PAOSHeader.java,v 1.4 2008/06/25 05:47:20 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>PAOSHeader</code> class is used by a web application
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * on HTTP server side to parse a <code>PAOS</code> header in an HTTP request
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * from the user agent side. This header is used by the User Agent
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * as a <code>PAOS</code> server to publish which services are available, which
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>PAOS</code> versions are supported, etc..
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * An example <code>PAOS</code> header looks like the following:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * PAOS: ver="ver1","ver2",ext="ext1","ext2";"service1","opt11",
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "opt12";"service2","opt21","opt22"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class has methods for obtaining all the parts inside such
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private ArrayList versionList = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private ArrayList extensionList = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private static final String PAOS_HEADER = "PAOS";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // keys are strings and value are sets (set elements are
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private HashMap servicesAndOptions = new HashMap();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This constructor accepts an <code>HttpServletRequest</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * and tries to parse the <code>PAOS</code> header string if there is one
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param req the incoming HTTP request which is supposed
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * to contain the <code>PAOS</code> header.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws PAOSException if there are any parsing errors because
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * the <code>PAOS</code> header is not there at all or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * because its content is not compliant to the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>PAOS</code> specifications.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public PAOSHeader(HttpServletRequest req) throws PAOSException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster PAOSUtils.debug.message("PAOSHeader.PAOSHeader: PAOS Header = " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "PAOSHeader:PAOSHeader: No POAS header.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "There is no PAOS header.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This constructor accepts a <code>PAOS</code> header string and tries to
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param paosHeaderString the <code>PAOS</code> header string which
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * supposedly contains information on available services, etc..
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws PAOSException if there are any parsing error because the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>PAOS</code> header is invalid.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public PAOSHeader(String paosHeaderString) throws PAOSException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "PAOSHeader:PAOSHeader: No POAS header.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "There is no PAOS header.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Parses the <code>PAOS</code> Header.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "PAOSHeader:PAOSHeader: Null POAS header.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "PAOS header value is empty");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster vers = versExts.substring(0, indexOfExt).trim();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster StringTokenizer st3 = new StringTokenizer(versions, ",");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster versionList.add(trimQuotes(st3.nextToken().trim()));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String extensions = versExts.substring(indexOfExt+4).trim();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster StringTokenizer st4 = new StringTokenizer(extensions, ",");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster extensionList.add(trimQuotes(st4.nextToken().trim()));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster optSet.add(trimQuotes(st5.nextToken().trim()));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((inStr.startsWith("\"") && inStr.endsWith("\"")) ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster (inStr.startsWith("'") && inStr.endsWith("'"))) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the list of versions as <code>String</code>s.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the list of versions as <code>String</code>s.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the list of extensions as <code>String</code>s.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the list of extensions as <code>String</code>s.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a <code>HashMap</code> containing the services and
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * corresponding options.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a <code>HashMap</code> with each key being a service represented
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * as a <code>String</code>, and with each value being a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>Set</code> of the corresponding options represented
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * as <code>String</code>s