message/common/RequestAuthnContext.java

a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
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 *
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 * opensso/legal/CDDLv1.0.txt
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * at opensso/legal/CDDLv1.0.txt.
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 *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: RequestAuthnContext.java,v 1.2 2008/06/25 05:46:47 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Portions Copyrighted 2014 ForgeRock AS
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.federation.message.common;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.common.FSUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.common.IFSConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.encode.URLEncDec;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.xml.XMLUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.ArrayList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.Collections;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.Iterator;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.List;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.StringTokenizer;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport javax.servlet.http.HttpServletRequest;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Element;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Node;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.NodeList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class <code>RequestAuthnContext</code> represents the requesting
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Authentication Context as part of the <code>FSAuthnRequest</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @deprecated since 12.0.0
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster@Deprecated
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class RequestAuthnContext {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private List authnContextClassRefList = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private List authnContextStatementRefList = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String authnContextComparison = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private int minorVersion = 0;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructor to create <code>RequestAuthnContext</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param authnContextClassRefList
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        Ordered list of AuthnContext Classes Refs.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param authnContextStatementRefList
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        Ordered list of AuthnContext Statement Refs.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        Note: authnContextClassRefList and authContextStatementRefList
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        are mutually exclusive lists.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param authnContextComparison AuthnContext Comparison Type.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        Possible values are  <code>exact</code>, <code>minimum<code>,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        <code>better</code> and <code>maximum</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public RequestAuthnContext (
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        List authnContextClassRefList,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        List authnContextStatementRefList,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String authnContextComparison) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.authnContextStatementRefList = authnContextStatementRefList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.authnContextClassRefList = authnContextClassRefList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.authnContextComparison = authnContextComparison;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Default constructor.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public RequestAuthnContext(){}
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructor to create <code>RequestAuthnContext</code> object from
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Docuemnt Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param root the Document Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws FSMsgException on error.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public RequestAuthnContext(Element root) throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(root == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            FSUtils.debug.message("AuthnContext.parseXML: null input.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("nullInput",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String tag = root.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(tag == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            FSUtils.debug.error("AuthnContext.parseXML: wrong input.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("wrongInput",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(!tag.equals("RequestAuthnContext") && !tag.equals("AuthnContext")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            FSUtils.debug.error("AuthnContext.parseXML: wrong input.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("wrongInput",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        NodeList nl = root.getChildNodes();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        int length = nl.getLength();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        for(int i = 0; i < length; i++) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            Node child = nl.item(i);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            String childName = child.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if(childName == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                continue;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if(childName.equals("AuthnContextClassRef")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                if(authnContextStatementRefList != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    FSUtils.debug.error("AuthnContext(Element): Should"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            + "contain either <AuthnContextStatementRef> or "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            + "<AuthnContextClassRef>");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    throw new FSMsgException("wrongInput",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                if(authnContextClassRefList == null ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        authnContextClassRefList == Collections.EMPTY_LIST) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    authnContextClassRefList = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                authnContextClassRefList.add(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        XMLUtils.getElementValue((Element) child));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } else if (childName.equals("AuthnContextStatementRef")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                if(authnContextClassRefList != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    FSUtils.debug.error("AuthnContext(Element): Should"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            + "contain either <AuthnContextStatementRef> or "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            + "<AuthnContextClassRef>");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    throw new FSMsgException("wrongInput",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                if(authnContextStatementRefList == null ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                       authnContextStatementRefList == Collections.EMPTY_LIST) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    authnContextStatementRefList = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                authnContextStatementRefList.add(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        XMLUtils.getElementValue((Element) child));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } else if(childName.equals("AuthnContextComparison")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                authnContextComparison = XMLUtils.getElementValue(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        (Element)child);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns <code>List</code> of <code>AuthnContext</code> Class References.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return <code>List</code> of <code>AuthnContext</code> Class Reference
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         classes.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setAuthnContextClassRefList(List)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public List getAuthnContextClassRefList() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return authnContextClassRefList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets a <code>List</code> of  <code>AuthnContext</code> Class References.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param authnContextClassRefList a <code>List</code> of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        <code>AuthnContext</code> Class References.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getAuthnContextClassRefList
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setAuthnContextClassRefList(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        List authnContextClassRefList) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.authnContextClassRefList = authnContextClassRefList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a <code>List</code> of <code>AuthnContext</code> Statement
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * References.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return a <code>List</code> of <code>AuthnContext</code> Statement
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         References.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setAuthnContextStatementRefList(List)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public List getAuthnContextStatementRefList() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return this.authnContextStatementRefList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets a <code>List</code> of <code>AuthnContext</code> Statement
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * References.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param authnContextStatementRefList a <code>List</code> of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        <code>AuthnContext</code> Statement References.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getAuthnContextStatementRefList
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setAuthnContextStatementRefList(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    List authnContextStatementRefList ) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.authnContextStatementRefList = authnContextStatementRefList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the <code>AuthnContext</code> Comparison type.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return authnContextComparison the <code>AuthnContext</code> Comparison
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *          type.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setAuthnContextComparison(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getAuthnContextComparison() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return authnContextComparison;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets the <code>AuthnContext</code> comparison type.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param authnContextComparison the <code>AuthnContext</code> comparison
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        type.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getAuthnContextComparison
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setAuthnContextComparison(String authnContextComparison) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.authnContextComparison = authnContextComparison;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the <code>MinorVersion</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return the <code>MinorVersion</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setMinorVersion(int)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public int getMinorVersion() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster       return minorVersion;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets the <code>MinorVersion</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param minorVersion the <code>MinorVersion</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getMinorVersion()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setMinorVersion(int minorVersion) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.minorVersion = minorVersion;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a String representation of the Logout Response.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return a string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws FSMsgException if there is an error converting
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         this object ot a string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toXMLString() throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return this.toXMLString(true, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a String representation of this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param includeNS : Determines whether or not the namespace qualifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        is prepended to the Element when converted
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param declareNS : Determines whether or not the namespace is declared
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        within the Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return a string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws FSMsgException if there is an error converting
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         this object to a string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toXMLString(boolean includeNS, boolean declareNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                              throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      return toXMLString(includeNS, declareNS, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a String representation of the Logout Response.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param includeNS Determines whether or not the namespace qualifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        is prepended to the Element when converted
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param declareNS Determines whether or not the namespace is declared
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        within the Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param includeHeader Determines whether the output include the xml
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        declaration header.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return a string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws FSMsgException if there is an error converting
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         this object ot a string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toXMLString(boolean includeNS, boolean declareNS,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                              boolean includeHeader) throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        StringBuffer xml = new StringBuffer(300);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (includeHeader) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            xml.append("<?xml version=\"1.0\" encoding=\"").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                append(SAMLConstants.DEFAULT_ENCODING).append("\" ?>\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String prefixAC = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String prefixLIB = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String uriAC = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String uriLIB = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (includeNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            prefixLIB = IFSConstants.LIB_PREFIX;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            prefixAC = IFSConstants.AC_PREFIX;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if(minorVersion == IFSConstants.FF_12_PROTOCOL_MINOR_VERSION) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               uriLIB = IFSConstants.LIB_12_NAMESPACE_STRING;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               uriAC = IFSConstants.AC_12_NAMESPACE_STRING;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               uriLIB = IFSConstants.LIB_NAMESPACE_STRING;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               uriAC = IFSConstants.AC_NAMESPACE_STRING;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        xml.append("<").append(prefixLIB);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(minorVersion == IFSConstants.FF_12_PROTOCOL_MINOR_VERSION) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           xml.append("RequestAuthnContext");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           xml.append("AuthnContext");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        xml.append(uriLIB).append(">\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((authnContextClassRefList != null) &&
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            (authnContextClassRefList != Collections.EMPTY_LIST)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if((authnContextStatementRefList != null) &&
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               (authnContextClassRefList != Collections.EMPTY_LIST)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               throw new FSMsgException("ExclusiveEntries",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            Iterator j = authnContextClassRefList.iterator();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            while (j.hasNext()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                xml.append("<").append(prefixLIB).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    append("AuthnContextClassRef").append(">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                xml.append((String)j.next());
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                xml.append("</").append(prefixLIB).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    append("AuthnContextClassRef").append(">\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
        }


        if ((authnContextStatementRefList != null) &&
            (authnContextStatementRefList != Collections.EMPTY_LIST)) {

            Iterator j = authnContextStatementRefList.iterator();
            while (j.hasNext()) {
                xml.append("<").append(prefixLIB).
                    append("AuthnContextStatementRef").append(">");
                xml.append((String)j.next());
                xml.append("</").append(prefixLIB).
                    append("AuthnContextStatementRef").append(">\n");
            }
        }

        if(minorVersion == IFSConstants.FF_12_PROTOCOL_MINOR_VERSION) {
           xml.append("<").append(prefixLIB)
              .append("AuthnContextComparison").append(">")
              .append(authnContextComparison)
              .append("</").append(prefixLIB)
              .append("AuthnContextComparison").append(">\n");
        }

        xml.append("</").append(prefixLIB);
        if(minorVersion == IFSConstants.FF_12_PROTOCOL_MINOR_VERSION) {
           xml.append("RequestAuthnContext").append(">\n");
        } else {
           xml.append("AuthnContext").append(">\n");
        }

        return xml.toString();
    }

    /**
     * Returns <code>RequestAuthnContext</code> object. The
     * object is creating by parsing the <code>HttpServletRequest</code>
     * object.
     *
     * @param request the <code>HttpServletRequest</code> object.
     * @return <code><RequestAuthnContext/code> object.
     * @throws FSMsgException if there is an error
     *         creating <code>RequestAuthnContext</code> object.
     */
    public static RequestAuthnContext parseURLEncodedRequest(
           HttpServletRequest request, int minorVersion)
           throws FSMsgException {
        RequestAuthnContext retAuthnContext = new RequestAuthnContext();
        String strAuthnContextClassRef =
               request.getParameter("AuthnContextClassRef");

        if(strAuthnContextClassRef != null){
           StringTokenizer st = new StringTokenizer(strAuthnContextClassRef);

            while (st.hasMoreTokens()) {
               if (retAuthnContext.authnContextClassRefList == null) {
                   retAuthnContext.authnContextClassRefList = new ArrayList();
               }
               retAuthnContext.authnContextClassRefList.add(st.nextToken());
            }
        }

        String strAuthnContextStatementRef =
               request.getParameter("AuthnContextStatementRef");

        if(strAuthnContextStatementRef != null){
            StringTokenizer st =
                new StringTokenizer(strAuthnContextStatementRef);

            while (st.hasMoreTokens()) {
               if (retAuthnContext.authnContextStatementRefList == null) {
                   retAuthnContext.authnContextStatementRefList =
                                   new ArrayList();
               }
               retAuthnContext.authnContextStatementRefList.add(st.nextToken());
            }
        }

        String strAuthnContextComparison =
               request.getParameter("AuthnContextComparison");

        if(strAuthnContextComparison != null) {
           retAuthnContext.setAuthnContextComparison(strAuthnContextComparison);
        }

        retAuthnContext.setMinorVersion(minorVersion);

        return retAuthnContext;
    }


    /**
     * Returns an URL Encoded String.
     *
     * @return a url encoded query string.
     * @throws FSMsgException if there is an error.
     */
    public String toURLEncodedQueryString() throws FSMsgException {

       StringBuffer urlEncodedAuthnReq = new StringBuffer(300);

       if ((authnContextClassRefList != null) &&
           (!authnContextClassRefList.isEmpty())) {

           if((authnContextStatementRefList != null) &&
              (!authnContextStatementRefList.isEmpty())) {
               throw new FSMsgException("ExclusiveEntries",null);
           }

           StringBuffer strEncodedString = new StringBuffer(100);
           Iterator j = authnContextClassRefList.iterator();
           strEncodedString.append((String)j.next());

           while(j.hasNext()) {
               strEncodedString.append(" ").append((String)j.next());
           }

           urlEncodedAuthnReq.append("AuthnContextClassRef=").
                    append(URLEncDec.encode(strEncodedString.toString())).
                    append(IFSConstants.AMPERSAND);
        }

       if ((authnContextStatementRefList != null) &&
            (!authnContextStatementRefList.isEmpty())) {

            StringBuffer strEncodedString = new StringBuffer(100);
            Iterator j = authnContextStatementRefList.iterator();

            strEncodedString.append((String)j.next());
            while (j.hasNext()) {
                strEncodedString.append(" ").append((String)j.next());
            }

            urlEncodedAuthnReq.append("AuthnContextClassRef=").
                   append(URLEncDec.encode(strEncodedString.toString())).
                   append(IFSConstants.AMPERSAND);
        }

        if(minorVersion == IFSConstants.FF_12_PROTOCOL_MINOR_VERSION) {
            if(authnContextComparison != null) {
                   urlEncodedAuthnReq.append("AuthnContextComparison=").
                   append(URLEncDec.encode(authnContextComparison)).
                   append(IFSConstants.AMPERSAND);
            }
        }
        return urlEncodedAuthnReq.toString();
    }
}