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: AuthnContext.java,v 1.3 2008/06/25 05:46:46 qcheng Exp $
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * Portions Copyrighted 2014 ForgeRock AS
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.federation.message.common;
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 Foster * This class <code>AuthnContext</code> represents an Authentication Context
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * for the authenticated user with a requested authn context.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * @deprecated since 12.0.0
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster protected String authnContextStatementRef = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Default constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructor creates <code>AuthnContext</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param authnContextClassRef Authentication Context Class Reference URI
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param authnContextStatementRef Authentication Context
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Statement Reference URI
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public AuthnContext(String authnContextClassRef,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster this.authnContextClassRef = authnContextClassRef;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster this.authnContextStatementRef = authnContextStatementRef;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructor creates <code>AuthnContext</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * from the Document Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param root the Document Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException on error.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public AuthnContext(Element root) throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("AuthnContext(): null input.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((tag == null) || (!tag.equals("AuthnContext"))) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("AuthnContext: wrong input.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((namespace != null) && namespace.equals(IFSConstants.FF_12_XML_NS)){
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster minorVersion = IFSConstants.FF_12_PROTOCOL_MINOR_VERSION;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("AuthnContext(Element): Should"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "contain only one AuthnContextClassRef element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster authnContextClassRef = XMLUtils.getElementValue((Element) child);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } else if(childName.equals("AuthnContextStatementRef")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.error("AuthnContext(Element): Should contain "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + " only one AuthnContextStatementRef element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } else if(childName.equals("AuthenticationContextStatement")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster FSUtils.debug.message("AuthnContext(Element): " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "Authentication Statement");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the AuthnContext Class Reference URI.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the AuthnContext Class Reference URI.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setAuthnContextClassRef
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the AuthnContext Class Reference URI.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param authnContextClassRef AuthnContext Class Ref URI.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getAuthnContextClassRef
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setAuthnContextClassRef(String authnContextClassRef) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster this.authnContextClassRef = authnContextClassRef;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the AuthnContext Statement Reference URI.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the AuthnContext Statement Reference URI.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setAuthnContextStatementRef
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets AuthnContext Statement Reference URI.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param authnContextStatementRef AuthnContext Statement Ref URI.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getAuthnContextStatementRef
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster this.authnContextStatementRef = authnContextStatementRef;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>MinorVersion</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the Minor Version.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setMinorVersion(int)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>MinorVersion</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param version the minor version in the assertion.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setMinorVersion(int)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the string representation of this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This method translates the response to an XML document string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return An XML String representing the response. NOTE: this is a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * complete SAML response xml string with ResponseID,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * MajorVersion, etc.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString() throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return this.toXMLString(true, true);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation of this object.
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 ot a string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString(boolean includeNS,boolean declareNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return toXMLString(includeNS, declareNS, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation of this object.
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 public String toXMLString(boolean includeNS,boolean declareNS,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xml.append("<?xml version=\"1.0\" encoding=\"").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append(SAMLConstants.DEFAULT_ENCODING).append("\" ?>");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if(minorVersion == IFSConstants.FF_12_PROTOCOL_MINOR_VERSION) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append("AuthnContext").append(uriLIB).append(">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xml.append(IFSConstants.DEFAULT_AUTHNCONTEXT_PASSWORD);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append("AuthnContextStatementRef").append(">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append("AuthnContextStatementRef").append(">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append("AuthnContextStatementRef").append(">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xml.append(IFSConstants.DEFAULT_AUTHNCONTEXT_PASSWORD);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster append("AuthnContextStatementRef").append(">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xml.append("</").append(prefixLIB).append("AuthnContext").append(">");