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: SessionSubject.java,v 1.2 2008/06/25 05:47:22 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.assertion.SubjectConfirmation;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.message.FSSubject;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.message.common.IDPProvidedNameIdentifier;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.message.common.FSMsgException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.common.IFSConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.liberty.ws.common.wsse.WSSEConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.assertion.NameIdentifier;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>SessionSubject</code> class represents a liberty subject
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with associated session status.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructs a <code>SessionSubject<code> object from a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>NameIdentifier</code> object, <code>SubjectConfirmation</code> and
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>IDPProvidedNameIdentifier</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param nameIdentifier <code>NameIdentifier</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param subjectConfirmation <code>SubjectConfirmation</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param idpNameIdentifier <code>IDPProvidedNameIdentifier</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if <code>idpNameIdentifier</code> is null.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAMLException if both <code>nameIdentifier</code> and
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>subjectConfirmation</code> are null.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster super(nameIdentifier, subjectConfirmation, idpNameIdentifier);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructs a <code>SessionSubject</code> object from a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>NameIdentifier</code> object and a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>IDPProvidedNameIdentifier</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param nameIdentifier <code>NameIdentifier</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param idpNameIdentifier <code>IDPProvidedNameIdentifier</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if <code>idpNameIdentifier</code> is null.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAMLException if <code>nameIdentifier</code> is null.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructs a <code>SessionSubject</code> object from a DOM element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * which has already been built into a DOM.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param subjectElement An Element representing DOM tree for Subject object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAMLException if can not create the object of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>NameIdentifier</code> or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>SubjectConfirmation</code> inside the DOM element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if it could not process the Element properly,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * implying that there is an error in the sender or in the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * element definition.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SecurityTokenManager.debug.message("SessionSubject(Element): Called");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (SecurityTokenManager.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "SessionSubject: local name missing");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException(SAMLUtils.bundle.getString
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster ("nullInput")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (SecurityTokenManager.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "SessionSubject: invalid root element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException(SAMLUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "invalidElement")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (SecurityTokenManager.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "SessionSubject: No sub elements found");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException(SAMLUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "emptyElement")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (child.getNodeType() != Node.ELEMENT_NODE) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster setNameIdentifier(new NameIdentifier((Element)child));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } else if (childName.equals("SubjectConfirmation")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }else if (childName.equals("IDPProvidedNameIdentifier")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (SecurityTokenManager.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "SessionSubject: Invalid element encountered.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException(SAMLUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "invalidElement")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (SecurityTokenManager.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "SessionSubject: more than allowed elements passed");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException(SAMLUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "moreElement")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (SecurityTokenManager.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "SessionSubject: mandatory IDPProvidedNameIdentifier "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "missing");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new FSMsgException(SAMLUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "missingElement")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SecurityTokenManager.debug.message("SessionSubject(Element): leaving");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructs a <code>SessionSubject</code> object from a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>SubjectConfirmation</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param subjectConfirmation <code>SubjectConfirmation</code> object to be
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * added to the object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAMLException if <code>subjectConfirmation</code> is null.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public SessionSubject(SubjectConfirmation subjectConfirmation)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation of the element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * By default name space name is prepended to the element name
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * example <code><saml:Subject></code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if could not create a String
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * representation of this element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString() throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return this.toXMLString(true, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation of the <code><Subject></code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param includeNS if true prepends all elements by their Namespace
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * name example <code><saml:Subject></code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param declareNS if true includes the namespace within the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * generated XML.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a string containing the valid XML for this element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws FSMsgException if could not create a String
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * representation of this element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster secNSString = " " + WSSEConstants.TAG_XMLNS + ":" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xml.append(getNameIdentifier().toString(includeNS, declareNS));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xml.append(getSubjectConfirmation().toString(includeNS, declareNS));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xml.append(_idpNameIdentifier.toXMLString(includeNS, declareNS));