message/common/IDPProvidedNameIdentifier.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: IDPProvidedNameIdentifier.java,v 1.2 2008/06/25 05:46:47 qcheng Exp $
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * 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.assertion.NameIdentifier;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.xml.XMLUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Element;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class has methods to create the <code>NameIdentifier</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * object provided by the Identity Provider.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * @deprecated since 12.0.0
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna@Deprecated
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class IDPProvidedNameIdentifier extends NameIdentifier {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected int minorVersion = IFSConstants.FF_11_PROTOCOL_MINOR_VERSION;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructor creates <code>IDPProvidedNameIdentifier</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param name the Identity Provider name.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param nameQualifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param format
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws SAMLException on error.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public IDPProvidedNameIdentifier(String name,String nameQualifier,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            String format) throws SAMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                super(name, nameQualifier, format);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructor creates <code>IDPProvidedNameIdentifier</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * from Document Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param idpProvidedNameIdentifierElement the Document Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws FSMsgException on error.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public IDPProvidedNameIdentifier(Element idpProvidedNameIdentifierElement)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                     throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        FSUtils.debug.message("IDPProvidedNameIdentifier(Element):  Called");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Element elt = (Element) idpProvidedNameIdentifierElement;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String eltName = elt.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (eltName == null)  {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (FSUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                FSUtils.debug.message("IDPProvidedNameIdentifier(Element): "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        + "local name missing");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("nullInput",null) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (!(eltName.equals("IDPProvidedNameIdentifier")))  {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (FSUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                FSUtils.debug.message("IDPProvidedNameIdentifier(Element: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        + "invalid root element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("invalidElement",null) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String read = elt.getAttribute("NameQualifier");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (read != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            setNameQualifier(read);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        read = elt.getAttribute("Format");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (read != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            setFormat(read);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        read = XMLUtils.getElementValue(elt);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((read == null) || (read.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (FSUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                FSUtils.debug.message("IDPProvidedNameIdentifier(Element: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        + "null input specified");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("nullInput",null) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            setName(read);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructor creates <code> IDPProvidedNameIdentifier</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param securityDomain
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param name
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws FSMsgException on error.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public IDPProvidedNameIdentifier(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            String securityDomain, String name
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            ) throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (name== null || name.length() == 0 )  {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (FSUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                FSUtils.debug.message("IDPProvidedNameIdentifier: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        + "null input specified");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("nullInput",null) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        setName(name);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(securityDomain==null)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            setNameQualifier("");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        else
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            setNameQualifier(securityDomain);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets the <code>MinorVersion</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param version the <code>MinorVersion</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #getMinorVersion()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setMinorVersion(int version) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        minorVersion = version;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the <code>MinorVersion</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return the <code>MinorVersion</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @see #setMinorVersion(int)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public int getMinorVersion() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return minorVersion;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the string representation of this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return a string containing the valid <code>XML</code> for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws FSMsgException if there is an error creating
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         <code>XML</code> string from this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toXMLString() throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String xml = this.toXMLString(true, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return xml;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the 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 <code>XML</code> for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws FSMsgException if there is an error creating
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         <code>XML</code> string from this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String  toXMLString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            boolean includeNS, boolean declareNS
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            ) throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        StringBuffer xml = new StringBuffer(3000);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String NS="";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String appendNS="";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if(minorVersion == IFSConstants.FF_12_PROTOCOL_MINOR_VERSION) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                NS = IFSConstants.LIB_12_NAMESPACE_STRING;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                NS=IFSConstants.LIB_NAMESPACE_STRING;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (includeNS) appendNS=IFSConstants.LIB_PREFIX;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        xml.append("<").append(appendNS).append("IDPProvidedNameIdentifier").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                append(" ").append(NS).append(" ");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((getNameQualifier() != null) &&
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                     (!(getNameQualifier().length() == 0))) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            xml.append("NameQualifier").append("=\"")
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               .append(getNameQualifier())
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               .append("\"").append(" ");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((getFormat() != null) && (!(getFormat().length() == 0))) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            xml.append("Format").append("=\"").append(getFormat())
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               .append("\"").append(" ");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((getName() != null) && (!(getName().length() == 0))) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            xml.append(">").append(getName());
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            xml.append("</").append(appendNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               .append("IDPProvidedNameIdentifier").append(">\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           return xml.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}