saml/assertion/SubjectLocality.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: SubjectLocality.java,v 1.2 2008/06/25 05:47:33 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.saml.assertion;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.*;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLUtilsCommon;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLRequesterException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *The <code>SubjectLocality</code> element specifies the DNS domain name
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *and IP address for the system entity that performed the authentication.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *It exists as part of <code>AuthenticationStatement</code> element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class SubjectLocality {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    static SAMLConstants sc;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private java.lang.String _ipAddress=null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private java.lang.String _dnsAddress=null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *Default Constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public SubjectLocality() {}
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructs an instance of <code>SubjectLocality</code> from an existing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * XML block.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param localityElement A <code>org.w3c.dom.Element</code> representing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        DOM tree for <code>SubjectLocality</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception SAMLException 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     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public SubjectLocality(org.w3c.dom.Element localityElement)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throws SAMLException
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Element elt = (Element) localityElement;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String eltName = elt.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (eltName == null)  {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (SAMLUtilsCommon.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                SAMLUtilsCommon.debug.message("SubjectLocality: local name "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        + "missing");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAMLRequesterException(SAMLUtilsCommon.bundle.getString
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                ("nullInput")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (!(eltName.equals("SubjectLocality")))
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAMLException("invalidElement") ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String read = elt.getAttribute("IPAddress");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((read != null) && (read.length() != 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            _ipAddress= read;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        read = elt.getAttribute("DNSAddress");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((read != null) && (read.length() != 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            _dnsAddress=read;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructs an instance of <code>SubjectLocality</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param ipAddress String representing the IP Address of the entity
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        that was authenticated.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param dnsAddress String representing the DNS Address of the entity that
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        was authenticated. As per SAML specification  they are both
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        optional, so values can be null.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public SubjectLocality(String ipAddress,String dnsAddress) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (ipAddress == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            _ipAddress = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else  {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _ipAddress = ipAddress;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (dnsAddress == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            _dnsAddress = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            _dnsAddress = dnsAddress;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the IP address from <code>SubjectLocality</code> locality
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return A String representation of IP address.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.lang.String getIPAddress() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return _ipAddress;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets the DNS address for <code>SubjectLocality></code> locality.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param dnsAddress A String representation of DNS address.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return true indicating the success of the operation.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public boolean setDNSAddress(java.lang.String dnsAddress) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((dnsAddress == null) || (dnsAddress.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            SAMLUtilsCommon.debug.message("DNS Address is null");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _dnsAddress = dnsAddress;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets the IP address for <code>SubjectLocality</code> locality.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param ipAddress A String representation of IP address.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return true indicating the success of the operation.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public boolean setIPAddress(java.lang.String ipAddress) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((ipAddress == null) || (ipAddress.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            SAMLUtilsCommon.debug.message("IP Address is null");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _ipAddress = ipAddress;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the DNS address from <code>SubjectLocality</code> locality
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return A String representation of DNS address.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.lang.String getDNSAddress() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return _dnsAddress;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a String representation of the element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
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>&lt;saml:SubjectLocality&gt;</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.lang.String toString() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // call toString() with includeNS true by default and declareNS false
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String xml = this.toString(true, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return xml;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a String representation of the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>&lt;SubjectLocality&gt;</code> element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param includeNS Determines whether or not the namespace qualifier is
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        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     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.lang.String  toString(boolean includeNS, boolean declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        StringBuffer xml = new StringBuffer(3000);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String NS="";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String appendNS="";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (declareNS) NS=sc.assertionDeclareStr;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (includeNS) appendNS="saml:";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        xml.append("<").append(appendNS).append("SubjectLocality").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            append(" ").append(NS).append(" ");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((_ipAddress != null) && !(_ipAddress.length() == 0))
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            xml.append("IPAddress").append("=\"").append(_ipAddress).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                append("\"").append(" ");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((_dnsAddress != null) && !(_dnsAddress.length() == 0))
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            xml.append("DNSAddress").append("=\"").append(_dnsAddress).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                append("\"").append(" ");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            xml.append(sc.END_ELEMENT);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return xml.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster