message/common/EncryptableNameIdentifier.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: EncryptableNameIdentifier.java,v 1.4 2008/06/25 05:46:46 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 org.w3c.dom.Element;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.Date;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.common.FSException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.common.IFSConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.common.FSUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.assertion.NameIdentifier;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.DateUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.xml.XMLUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class contains methods for encrypting the  <code>NameIdentifier</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * @deprecated since 12.0.0
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna@Deprecated
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class EncryptableNameIdentifier {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private java.lang.String _nameQualifier = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private java.lang.String _name = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private java.lang.String _nonce = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private java.lang.String _format = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private java.util.Date _issueInstant = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Default Constructor.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected EncryptableNameIdentifier() {}
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructor creates <code>EncryptableNameIdentifier</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param ni the <code>NameIdentifier</code> object to be encrypted.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws FSException if there is an error.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public EncryptableNameIdentifier(NameIdentifier ni) throws FSException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(ni == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           throw new FSException("nullInput", null) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _nameQualifier = ni.getNameQualifier();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _name = ni.getName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(_nameQualifier == null || _name == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           throw new FSException("nullInput", null) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _format = ni.getFormat();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(_format == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           throw new FSException("notValidFormat", null) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _nonce = FSUtils.generateID();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _issueInstant = new Date();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Consturctor creates <code>EncryptableNameIdentifier</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param name
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param nameQualifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param format
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param issueInstant the Issue Instant
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param nonce
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws FSException if there is an error.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public EncryptableNameIdentifier(String name,String nameQualifier,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                     String format,Date issueInstant,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                     String nonce ) throws FSException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(name == null || nameQualifier == null || issueInstant == null ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            format == null || nonce == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           throw new FSException("nullInput", null) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _name = name;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _nameQualifier = nameQualifier;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _format = format;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _nonce = nonce;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _issueInstant = issueInstant;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructs a <code>EncryptedNameIdentifer</code> element from
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * the Document Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param nameIdentifier a <code>org.w3c.dom.Element</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        representing DOM tree for <code>EncryptableNameIdentifier</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws FSException if it could not process the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *            <code>org.w3c.dom.Element</code> properly, implying that there
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *            is an error in the sender or in the element definition.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public EncryptableNameIdentifier(org.w3c.dom.Element nameIdentifier)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throws FSException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Element elt = (Element) nameIdentifier;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String eltName = elt.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (eltName == null)  {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (FSUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                FSUtils.debug.message("EncryptableNameIdentifier: local" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                " name missing");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSException("nullInput", null) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (!(eltName.equals("EncryptableNameIdentifier")))  {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (FSUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                FSUtils.debug.message("EncryptableNameIdentifier: invalid"+
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                " root element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSException("invalidElement", null) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String read = elt.getAttribute("NameQualifier");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (read != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            _nameQualifier = read;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        read = elt.getAttribute("Format");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (read != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            _format = read;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        read = elt.getAttribute("Nonce");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (read != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            _nonce = read;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        read = elt.getAttribute("IssueInstant");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(read != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               _issueInstant = DateUtils.stringToDate(read);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           } catch (java.text.ParseException pe) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               if (FSUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                   FSUtils.debug.message("EncryptableNameIdentifier: "+
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                   "Could not parse issue instant", pe);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               throw new FSException("wrongInput", null) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           }
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("EncryptableNameIdentifier: null"+
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                " input specified");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSException("nullInput", null) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           _name = read;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns value of the <code>Format</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return value of the <code>Format</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.lang.String getFormat() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return _format;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets the <code>Format</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param format the value of the <code>Format</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return true if the operation succeeds.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public boolean setFormat(java.lang.String  format ) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // TODO do I need to restrict the format to those defined
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // by SAML specification ?
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((format == null) || (format.length() == 0))  {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _format = format;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the <code>NameQualifier</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return the <code>nameQualifier</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.lang.String  getNameQualifier() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return _nameQualifier;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets <code>nameQualifier</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param nameQualifier the  <code>nameQualifier</code> attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return true if operation succeeds.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public boolean setNameQualifier(java.lang.String  nameQualifier ) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((nameQualifier == null) || (nameQualifier.length() == 0))  {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _nameQualifier=nameQualifier;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets the name attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param name name of the <code>nameQualifier</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return true if operation succeeds.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected boolean setName(java.lang.String  name ) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((name == null) || (name.length() == 0))  {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        _name = name;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the name from <code>NameQualifier</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return the name from <code>NameQualifier</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.lang.String getName() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return _name;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Retunrs the nounce.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return the nounce.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.lang.String getNonce() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return _nonce;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the Issue Instant.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return the Issue Instant.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.util.Date getIssueInstant() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return _issueInstant;
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:EncryptableNameIdentifier&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 String representation of the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * <code>&lt;EncryptableNameIdentifier&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) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            NS=IFSConstants.LIB_12_NAMESPACE_STRING;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (includeNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            appendNS=IFSConstants.LIB_PREFIX;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String dateStr = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(_issueInstant != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           dateStr = DateUtils.toUTCDateFormat(_issueInstant);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        xml.append("<").append(appendNS).append("EncryptableNameIdentifier").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster             append(NS);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((_nameQualifier != null) && (!(_nameQualifier.length() == 0))) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            xml.append(" ").append("NameQualifier").append("=\"").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                append(_nameQualifier).append("\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((_format != null) && (!(_format.length() == 0))) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            xml.append(" ").append("Format").append("=\"").append(_format).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            append("\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((_nonce != null) && (!(_nonce.length() == 0))) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            xml.append(" ").append("Nonce").append("=\"").append(_nonce).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            append("\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((_issueInstant != null) && (dateStr.length() != 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            xml.append(" ").append("IssueInstant").append("=\"").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            append(dateStr).append("\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        xml.append(">").append(_name);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        xml.append("</").append(appendNS).append("EncryptableNameIdentifier").
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        append(">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           return xml.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}