assertion/impl/SubjectImpl.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: SubjectImpl.java,v 1.3 2008/06/25 05:47:44 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.saml2.assertion.impl;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Document;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Element;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Node;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.NodeList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.ArrayList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.Collections;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.List;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.xml.XMLUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.assertion.Subject;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.assertion.SubjectConfirmation;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.assertion.AssertionFactory;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.assertion.BaseID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.assertion.EncryptedID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.assertion.NameID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.common.SAML2Constants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.common.SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.common.SAML2SDKUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>Subject</code> specifies the principal that is the subject
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of all of the statements in the assertion. It contains an identifier,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * a series of one or more subject confirmations, or both.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class SubjectImpl implements Subject {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private List subjectConfirmations = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private BaseID baseId = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private NameID nameId = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private EncryptedID encryptedId = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private boolean isMutable = true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public static final String SUBJECT_ELEMENT = "Subject";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public static final String SUBJECT_CONFIRMATION_ELEMENT =
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                               "SubjectConfirmation";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public static final String BASE_ID_ELEMENT = "BaseID";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public static final String NAME_ID_ELEMENT = "NameID";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public static final String ENCRYPTED_ID_ELEMENT = "EncryptedID";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster   /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Default constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public SubjectImpl() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * This constructor is used to build <code>Subject</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * from a XML string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param xml A <code>java.lang.String</code> representing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        a <code>Subject</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception SAML2Exception if it could not process the XML string
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public SubjectImpl(String xml) throws SAML2Exception {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Document document = XMLUtils.toDOMDocument(xml, SAML2SDKUtils.debug);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (document != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            Element rootElement = document.getDocumentElement();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            processElement(rootElement);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            makeImmutable();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            SAML2SDKUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "SubjectImpl.processElement(): invalid XML input");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "errorObtainingElement"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * This constructor is used to build <code>Subject</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * from a block of existing XML that has already been built into
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * a DOM.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param element A <code>org.w3c.dom.Element</code> representing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        DOM tree for <code>Subject</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception SAML2Exception if it could not process the Element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public SubjectImpl(Element element) throws SAML2Exception {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        processElement(element);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        makeImmutable();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private void processElement(Element element) throws SAML2Exception {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (element == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            SAML2SDKUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "SubjectImpl.processElement(): invalid root element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "invalid_element"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String elemName = element.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (elemName == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            SAML2SDKUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "SubjectImpl.processElement(): local name missing");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "missing_local_name"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (!elemName.equals(SUBJECT_ELEMENT)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            SAML2SDKUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "SubjectImpl.processElement(): invalid local name "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                + elemName);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "invalid_local_name"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // starts processing subelements
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        NodeList nodes = element.getChildNodes();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        int numOfNodes = nodes.getLength();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (numOfNodes < 1) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            SAML2SDKUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "SubjectImpl.processElement(): subject has no subelements");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "missing_subelements"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        int nextElem = 0;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Node child = (Node)nodes.item(nextElem);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        while (child.getNodeType() != Node.ELEMENT_NODE) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (++nextElem >= numOfNodes) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                SAML2SDKUtils.debug.error("SubjectImpl.processElement():"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    + " subject has no subelements");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    "missing_subelements"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            child = (Node)nodes.item(nextElem);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String childName = child.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (childName != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (childName.equals(SUBJECT_CONFIRMATION_ELEMENT)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                subjectConfirmations.add(AssertionFactory.getInstance().
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    createSubjectConfirmation((Element)child));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } else if (childName.equals(BASE_ID_ELEMENT)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                baseId = AssertionFactory.getInstance().
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                         createBaseID((Element)child);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } else if (childName.equals(NAME_ID_ELEMENT)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                nameId = AssertionFactory.getInstance().
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                         createNameID((Element)child);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } else if (childName.equals(ENCRYPTED_ID_ELEMENT)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                encryptedId = AssertionFactory.getInstance().
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                         createEncryptedID((Element)child);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                SAML2SDKUtils.debug.error("SubjectImpl.processElement(): "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    + "unexpected subelement " + childName);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                      "unexpected_subelement"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (++nextElem >= numOfNodes) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // The next subelements are all <SubjectConfirmation>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        while (nextElem < numOfNodes) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            child = (Node)nodes.item(nextElem);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (child.getNodeType() == Node.ELEMENT_NODE) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                childName = child.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                if (childName != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    if (childName.equals(SUBJECT_CONFIRMATION_ELEMENT)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        subjectConfirmations.add(AssertionFactory.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            getInstance().createSubjectConfirmation(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            (Element)child));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        SAML2SDKUtils.debug.error("SubjectImpl."
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            +"processElement(): unexpected subelement "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            + childName);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        throw new SAML2Exception(SAML2SDKUtils.bundle.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            getString("unexpected_subelement"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            nextElem++;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  Returns the encrypted identifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  @return the encrypted identifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public EncryptedID getEncryptedID() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return encryptedId;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  Sets the encrypted identifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  @param value the encrypted identifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setEncryptedID(EncryptedID value)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throws SAML2Exception{
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (!isMutable) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "objectImmutable"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        encryptedId = value;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  Returns the identifier in <code>NameID</code> format
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  @return the identifier in <code>NameID</code> format
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public NameID getNameID() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return nameId;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  Sets the identifier in <code>NameID</code> format
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  @param value the identifier in <code>NameID</code> format
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setNameID(NameID value) throws SAML2Exception {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (!isMutable) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "objectImmutable"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        nameId = value;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a list of subject confirmations
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return a list of subject confirmations
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public List getSubjectConfirmation() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return subjectConfirmations;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets a list of subject confirmations
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param confirmations a list of subject confirmations
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setSubjectConfirmation(List confirmations)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throws SAML2Exception {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (!isMutable) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "objectImmutable"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        subjectConfirmations = confirmations;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  Returns the identifier in <code>BaseID</code> format
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  @return the identifier in <code>BaseID</code> format
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public BaseID getBaseID() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return baseId;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  Sets the identifier in <code>BaseID</code> format
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  @param value the identifier in <code>BaseID</code> format
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *  @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setBaseID(BaseID value) throws SAML2Exception {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (!isMutable) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                "objectImmutable"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        baseId = value;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster   /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Returns a String representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @param includeNSPrefix Determines whether or not the namespace
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    *        qualifier is prepended to the Element when converted
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @param declareNS Determines whether or not the namespace is
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    *        declared within the Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @return A String representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @exception SAML2Exception if something is wrong during conversion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toXMLString(boolean includeNSPrefix, boolean declareNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throws SAML2Exception {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        StringBuffer sb = new StringBuffer(2000);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String NS = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String appendNS = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            NS = SAML2Constants.ASSERTION_DECLARE_STR;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (includeNSPrefix) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            appendNS = SAML2Constants.ASSERTION_PREFIX;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sb.append("<").append(appendNS).append(SUBJECT_ELEMENT).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            append(NS).append(">\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        boolean idFound = false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (baseId != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            sb.append(baseId.toXMLString(includeNSPrefix, false));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            idFound = true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (nameId != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (idFound) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                SAML2SDKUtils.debug.error("SubjectImpl.toXMLString(): "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    + "more than one types of id specified");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                      "too_many_ids_specified"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                sb.append(nameId.toXMLString(includeNSPrefix, false));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                idFound = true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (encryptedId != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (idFound) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                SAML2SDKUtils.debug.error("SubjectImpl.toXMLString(): "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    + "more than one types of id specified");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                      "too_many_ids_specified"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                sb.append(encryptedId.toXMLString(includeNSPrefix, false));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                idFound = true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        int length = subjectConfirmations.size();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (length == 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (!idFound) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                SAML2SDKUtils.debug.error("SubjectImpl.toXMLString(): Need at "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    + "least one id or one subject confirmation in a subject");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                throw new SAML2Exception(SAML2SDKUtils.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    "need_at_least_one_id_or_on_SubjectConfirmation"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            for (int i = 0; i < length; i++) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                SubjectConfirmation sc =
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    (SubjectConfirmation)subjectConfirmations.get(i);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                sb.append(sc.toXMLString(includeNSPrefix, false));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sb.append("</").append(appendNS).append(SUBJECT_ELEMENT).append(">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return sb.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster   /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Returns a String representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @return A String representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @exception SAML2Exception if something is wrong during conversion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toXMLString() throws SAML2Exception {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return this.toXMLString(true, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster   /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Makes the object immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void makeImmutable() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (isMutable) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (subjectConfirmations != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                int length = subjectConfirmations.size();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                for (int i = 0; i < length; i++) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    SubjectConfirmation subjectConfirmation =
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        (SubjectConfirmation)subjectConfirmations.get(i);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    subjectConfirmation.makeImmutable();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                subjectConfirmations =
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    Collections.unmodifiableList(subjectConfirmations);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (baseId != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                baseId.makeImmutable();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (nameId != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                nameId.makeImmutable();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            isMutable = false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster   /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Returns true if the object is mutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @return true if the object is mutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public boolean isMutable() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return isMutable;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}