src/org/apache/xml/security/utils/ElementProxy.java - santuario-xml-security-java - Git at Google

 /*
  * The Apache Software License, Version 1.1
  *
  *
  * Copyright (c) 1999 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  *
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in
  *    the documentation and/or other materials provided with the
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution,
  *    if any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
  *    Alternately, this acknowledgment may appear in the software itself,
  *    if and wherever such third-party acknowledgments normally appear.
  *
  * 4. The names "<WebSig>" and "Apache Software Foundation" must
  *    not be used to endorse or promote products derived from this
  *    software without prior written permission. For written
  *    permission, please contact apache@apache.org.
  *
  * 5. Products derived from this software may not be called "Apache",
  *    nor may "Apache" appear in their name, without prior written
  *    permission of the Apache Software Foundation.
  *
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  * ====================================================================
  *
  * This software consists of voluntary contributions made by many
  * individuals on behalf of the Apache Software Foundation and was
  * originally based on software copyright (c) 2001, Institute for
  * Data Communications Systems, <http://www.nue.et-inf.uni-siegen.de/>.
  * The development of this software was partly funded by the European
  * Commission in the <WebSig> project in the ISIS Programme.
  * For more information on the Apache Software Foundation, please see
  * <http://www.apache.org/>.
  */
 package org.apache.xml.security.utils;


 import java.math.BigInteger;
 import java.util.HashMap;
 import java.util.Iterator;

 import javax.xml.transform.TransformerException;

 import org.apache.xml.security.exceptions.XMLSecurityException;
 import org.apache.xpath.XPathAPI;
 import org.w3c.dom.Attr;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 import org.w3c.dom.Text;


 /**
  * This is the base class to all Objects which have a direct 1:1 mapping to an
  * Element in a particular namespace.
  *
  * @author $Author$
  */
 public abstract class ElementProxy {

    /** {@link org.apache.commons.logging} logging facility */
     static org.apache.commons.logging.Log log =
         org.apache.commons.logging.LogFactory.getLog(ElementProxy.class.getName());
    //J-
    public static final int MODE_CREATE  = 0;
    public static final int MODE_PROCESS = 1;
    public static final int MODE_UNKNOWN = 2;

    public static final int MODE_SIGN    = MODE_CREATE;
    public static final int MODE_VERIFY  = MODE_PROCESS;

    public static final int MODE_ENCRYPT = MODE_CREATE;
    public static final int MODE_DECRYPT = MODE_PROCESS;

    protected int _state = MODE_UNKNOWN;
    //J+

    /**
     * Returns the namespace of the Elements of the sub-class.
     *
     * @return the namespace of the Elements of the sub-class.
     */
    public abstract String getBaseNamespace();

    /**
     * Returns the localname of the Elements of the sub-class.
     *
     * @return the localname of the Elements of the sub-class.
     */
    public abstract String getBaseLocalName();

    /** Field _constructionElement */
    protected Element _constructionElement = null;

    /** Field _baseURI */
    protected String _baseURI = null;

    /** Field _doc */
    protected Document _doc = null;

    /**
     * Constructor ElementProxy
     *
     */
    public ElementProxy() {

       this._doc = null;
       this._state = ElementProxy.MODE_UNKNOWN;
       this._baseURI = null;
       this._constructionElement = null;
    }

    /**
     * Constructor ElementProxy
     *
     * @param doc
     */
    public ElementProxy(Document doc) {

       this();

       if (doc == null) {
          throw new RuntimeException("Document is null");
       }

       this._doc = doc;
       this._state = ElementProxy.MODE_CREATE;
       this._constructionElement = ElementProxy.createElementForFamily(this._doc,
               this.getBaseNamespace(), this.getBaseLocalName());
    }

    /**
     * This method creates an Element in a given namespace with a given localname.
     * It uses the {@link ElementProxy#getDefaultPrefix} method to decide whether
     * a particular prefix is bound to that namespace.
     * <BR />
     * This method was refactored out of the constructor.
     *
     * @param doc
     * @param namespace
     * @param localName
     *
     */
    public static Element createElementForFamily(Document doc, String namespace,
            String localName) {

       Element result = null;
       String prefix = ElementProxy.getDefaultPrefix(namespace);

       if (namespace == null) {
          result = doc.createElementNS(null, localName);
       } else {
          if ((prefix == null) || (prefix.length() == 0)) {
             result = doc.createElementNS(namespace, localName);

             result.setAttributeNS(Constants.NamespaceSpecNS, "xmlns",
                                   namespace);
          } else {
             result = doc.createElementNS(namespace, prefix + ":" + localName);

             result.setAttributeNS(Constants.NamespaceSpecNS, "xmlns:" + prefix,
                                   namespace);
          }
       }

       return result;
    }

    /**
     * Method setElement
     *
     * @param element
     * @param BaseURI
     * @throws XMLSecurityException
     */
    public void setElement(Element element, String BaseURI)
            throws XMLSecurityException {

       if (element == null) {
          throw new XMLSecurityException("ElementProxy.nullElement");
       }

       log.debug("setElement(" + element.getTagName() + ", \"" + BaseURI + "\"");

       this._doc = element.getOwnerDocument();
       this._state = ElementProxy.MODE_PROCESS;
       this._constructionElement = element;
       this._baseURI = BaseURI;
    }

    /**
     * Constructor ElementProxy
     *
     * @param element
     * @param BaseURI
     * @throws XMLSecurityException
     */
    public ElementProxy(Element element, String BaseURI)
            throws XMLSecurityException {

       this();

       if (element == null) {
          throw new XMLSecurityException("ElementProxy.nullElement");
       }

       log.debug("setElement(\"" + element.getTagName() + "\", \"" + BaseURI
                 + "\")");

       this._doc = element.getOwnerDocument();
       this._state = ElementProxy.MODE_PROCESS;
       this._constructionElement = element;
       this._baseURI = BaseURI;

       this.guaranteeThatElementInCorrectSpace();
    }

    /**
     * Returns the Element which was constructed by the Object.
     *
     * @return the Element which was constructed by the Object.
     */
    public final Element getElement() {
       return this._constructionElement;
    }

    /**
     * Returns the Element plus a leading and a trailing CarriageReturn Text node.
     *
     * @return the Element which was constructed by the Object.
     */
    public final NodeList getElementPlusReturns() {

       HelperNodeList nl = new HelperNodeList();

       nl.appendChild(this._doc.createTextNode("\n"));
       nl.appendChild(this.getElement());
       nl.appendChild(this._doc.createTextNode("\n"));

       return nl;
    }

    /**
     * Method getDocument
     *
     *
     */
    public Document getDocument() {
       return this._doc;
    }

    /**
     * Method getBaseURI
     *
     *
     */
    public String getBaseURI() {
       return this._baseURI;
    }

    /**
     * Method guaranteeThatElementInCorrectSpace
     *
     * @throws XMLSecurityException
     */
    public void guaranteeThatElementInCorrectSpace()
            throws XMLSecurityException {

       String localnameSHOULDBE = this.getBaseLocalName();
       String namespaceSHOULDBE = this.getBaseNamespace();
       String qnameSHOULDBE = "{" + ((namespaceSHOULDBE == null)
                                     ? ""
                                     : namespaceSHOULDBE) + "}"
                                                          + localnameSHOULDBE;
       String localnameIS = this._constructionElement.getLocalName();
       String namespaceIS = this._constructionElement.getNamespaceURI();
       String qnameIS = "{" + ((namespaceIS == null)
                               ? ""
                               : namespaceIS) + "}" + localnameIS;

       if (!qnameIS.equals(qnameSHOULDBE)) {
          Object exArgs[] = { qnameSHOULDBE, qnameIS };

          throw new XMLSecurityException("xml.WrongElement", exArgs);
       }
    }

    /**
     * Method setVal
     *
     * @param bi
     * @param localname
     */
    public void addBigIntegerElement(BigInteger bi, String localname) {

       if (bi != null) {
          Element e = XMLUtils.createElementInSignatureSpace(this._doc,
                         localname);

          Base64.fillElementWithBigInteger(e, bi);
          this._constructionElement.appendChild(e);
          XMLUtils.addReturnToElement(this._constructionElement);
       }
    }

    /**
     * Method addBase64Element
     *
     * @param bytes
     * @param localname
     */
    public void addBase64Element(byte[] bytes, String localname) {

       if (bytes != null) {
          Element e = Base64.encodeToElement(this._doc, localname, bytes);

          this._constructionElement.appendChild(e);
          this._constructionElement.appendChild(this._doc.createTextNode("\n"));
       }
    }

    /**
     * Method addTextElement
     *
     * @param text
     * @param localname
     */
    public void addTextElement(String text, String localname) {

       Element e = XMLUtils.createElementInSignatureSpace(this._doc, localname);
       Text t = this._doc.createTextNode(text);

       e.appendChild(t);
       this._constructionElement.appendChild(e);
       XMLUtils.addReturnToElement(this._constructionElement);
    }

    /**
     * Method addBase64Text
     *
     * @param bytes
     */
    public void addBase64Text(byte[] bytes) {

       if (bytes != null) {
          Text t = this._doc.createTextNode("\n" + Base64.encode(bytes) + "\n");

          this._constructionElement.appendChild(t);
       }
    }

    /**
     * Method addText
     *
     * @param text
     */
    public void addText(String text) {

       if (text != null) {
          Text t = this._doc.createTextNode(text);

          this._constructionElement.appendChild(t);
       }
    }

    /**
     * Method getVal
     *
     * @param localname
     * @param namespace
     *
     * @throws XMLSecurityException
     */
    public BigInteger getBigIntegerFromChildElement(
            String localname, String namespace) throws XMLSecurityException {

       try {
          Element nscontext = XMLUtils.createDSctx(this._doc, "x", namespace);
          Text t = (Text) XPathAPI.selectSingleNode(this._constructionElement,
                                                    "./x:" + localname
                                                    + "/text()", nscontext);

          return Base64.decodeBigIntegerFromText(t);
       } catch (TransformerException ex) {
          throw new XMLSecurityException("empty", ex);
       }
    }

    /**
     * Method getBytesFromChildElement
     *
     * @param localname
     * @param namespace
     *
     * @throws XMLSecurityException
     */
    public byte[] getBytesFromChildElement(String localname, String namespace)
            throws XMLSecurityException {

       try {
          Element nscontext = XMLUtils.createDSctx(this._doc, "x", namespace);
          Element e =
             (Element) XPathAPI.selectSingleNode(this._constructionElement,
                                                 "./x:" + localname, nscontext);

          return Base64.decode(e);
       } catch (TransformerException ex) {
          throw new XMLSecurityException("empty", ex);
       }
    }

    /**
     * Method getTextFromChildElement
     *
     * @param localname
     * @param namespace
     *
     * @throws XMLSecurityException
     */
    public String getTextFromChildElement(String localname, String namespace)
            throws XMLSecurityException {

       try {
          Element nscontext = XMLUtils.createDSctx(this._doc, "x", namespace);
          Text t = (Text) XPathAPI.selectSingleNode(this._constructionElement,
                                                    "./x:" + localname
                                                    + "/text()", nscontext);

          return t.getData();
       } catch (TransformerException ex) {
          throw new XMLSecurityException("empty", ex);
       }
    }

    /**
     * Method getBytesFromTextChild
     *
     *
     * @throws XMLSecurityException
     */
    public byte[] getBytesFromTextChild() throws XMLSecurityException {

       try {
          Text t = (Text) XPathAPI.selectSingleNode(this._constructionElement,
                                                    "./text()");

          return Base64.decode(t.getData());
       } catch (TransformerException ex) {
          throw new XMLSecurityException("empty", ex);
       }
    }

    /**
     * Method getTextFromTextChild
     *
     *
     */
    public String getTextFromTextChild() {
       return XMLUtils.getFullTextChildrenFromElement(this._constructionElement);
    }

    /**
     * This method returns the index&apos;th child with the given namespace
     * and localname.
     *
     * @param index
     * @param namespace
     * @param localname
     * @return null if the Element does not contain the requested child
     */
    public Element getChildElementLocalName(int index, String namespace,
                                            String localname) {

       NodeList childNodes = this._constructionElement.getChildNodes();
       int maxLength = childNodes.getLength();
       int result = -1;

       for (int i = 0; i < maxLength; i++) {
          Node n = childNodes.item(i);

          if (n.getNodeType() == Node.ELEMENT_NODE) {
             String ns = n.getNamespaceURI();
             String name = n.getLocalName();

             if (((namespace != null) && (ns != null) && namespace.equals(ns))
                     || ((namespace == null) && (ns == null))) {
                if (localname.equals(name)) {
                   result++;

                   if (result == index) {
                      return (Element) n;
                   }
                }
             }
          }
       }

       // throw new IndexOutOfBoundsException("Try to get " + index + "/" + maxLength + " {" + namespace + "}" + localname + " from " + this._constructionElement.getTagName());
       return null;
    }

    /**
     * Method length
     *
     * @param namespace
     * @param localname
     *
     */
    public int length(String namespace, String localname) {

       NodeList childNodes = this._constructionElement.getChildNodes();
       int maxLength = childNodes.getLength();
       int result = 0;

       for (int i = 0; i < maxLength; i++) {
          Node n = childNodes.item(i);

          if (n.getNodeType() == Node.ELEMENT_NODE) {
             String ns = n.getNamespaceURI();
             String name = n.getLocalName();

             if (((namespace != null) && (ns != null) && namespace.equals(ns))
                     || ((namespace == null) && (ns == null))) {
                if (localname.equals(name)) {
                   result++;
                }
             }
          }
       }

       return result;
    }

    /**
     * Adds an xmlns: definition to the Element. This can be called as follows:
     *
     * <PRE>
     * // set namespace with ds prefix
     * xpathContainer.setXPathNamespaceContext("ds", "http://www.w3.org/2000/09/xmldsig#");
     * xpathContainer.setXPathNamespaceContext("xmlns:ds", "http://www.w3.org/2000/09/xmldsig#");
     * </PRE>
     *
     * @param prefix
     * @param uri
     * @throws XMLSecurityException
     */
    public void setXPathNamespaceContext(String prefix, String uri)
            throws XMLSecurityException {

       String ns;

       if ((prefix == null) || (prefix.length() == 0)) {
          ns = "xmlns";
       } else if (prefix.equals("xmlns")) {
          ns = "xmlns";
       } else if (prefix.startsWith("xmlns:")) {
          ns = "xmlns:" + prefix.substring("xmlns:".length());
       } else {
          ns = "xmlns:" + prefix;
       }

       if (ns.equals("xmlns")) {
          throw new XMLSecurityException("defaultNamespaceCannotBeSetHere");
       }

       Attr a = this._constructionElement.getAttributeNodeNS(Constants.NamespaceSpecNS, ns);

       if ((a != null) && (!a.getNodeValue().equals(uri))) {
          Object exArgs[] = { ns,
                              this._constructionElement.getAttributeNS(null,
                                                                       ns) };

          throw new XMLSecurityException("namespacePrefixAlreadyUsedByOtherURI",
                                         exArgs);
       }

       this._constructionElement.setAttributeNS(Constants.NamespaceSpecNS, ns,
                                                uri);
    }

    /** Field _prefixMappings */
    static HashMap _prefixMappings = new HashMap();

    /**
     * Method setDefaultPrefix
     *
     * @param namespace
     * @param prefix
     * @throws XMLSecurityException
     */
    public static void setDefaultPrefix(String namespace, String prefix)
            throws XMLSecurityException {

       Iterator keys = ElementProxy._prefixMappings.keySet().iterator();

       while (keys.hasNext()) {
          String storedNamespace = (String) keys.next();
          String storedPrefix =
             (String) ElementProxy._prefixMappings.get(storedNamespace);

          if (storedPrefix.equals(prefix) &&!storedNamespace.equals(namespace)) {
             Object exArgs[] = { prefix, namespace, storedNamespace };

             throw new XMLSecurityException("prefix.AlreadyAssigned", exArgs);
          }
       }

       ElementProxy._prefixMappings.put(namespace, prefix);
    }

    /**
     * Method getDefaultPrefix
     *
     * @param namespace
     *
     */
    public static String getDefaultPrefix(String namespace) {

       String prefix = (String) ElementProxy._prefixMappings.get(namespace);

       return prefix;
    }
 }
	/*
	* The Apache Software License, Version 1.1
	*
	*
	* Copyright (c) 1999 The Apache Software Foundation. All rights
	* reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	*
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in
	* the documentation and/or other materials provided with the
	* distribution.
	*
	* 3. The end-user documentation included with the redistribution,
	* if any, must include the following acknowledgment:
	* "This product includes software developed by the
	* Apache Software Foundation (http://www.apache.org/)."
	* Alternately, this acknowledgment may appear in the software itself,
	* if and wherever such third-party acknowledgments normally appear.
	*
	* 4. The names "<WebSig>" and "Apache Software Foundation" must
	* not be used to endorse or promote products derived from this
	* software without prior written permission. For written
	* permission, please contact apache@apache.org.
	*
	* 5. Products derived from this software may not be called "Apache",
	* nor may "Apache" appear in their name, without prior written
	* permission of the Apache Software Foundation.
	*
	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
	* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
	* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
	* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	* SUCH DAMAGE.
	* ====================================================================
	*
	* This software consists of voluntary contributions made by many
	* individuals on behalf of the Apache Software Foundation and was
	* originally based on software copyright (c) 2001, Institute for
	* Data Communications Systems, <http://www.nue.et-inf.uni-siegen.de/>.
	* The development of this software was partly funded by the European
	* Commission in the <WebSig> project in the ISIS Programme.
	* For more information on the Apache Software Foundation, please see
	* <http://www.apache.org/>.
	*/
	package org.apache.xml.security.utils;



	import java.math.BigInteger;
	import java.util.HashMap;
	import java.util.Iterator;

	import javax.xml.transform.TransformerException;

	import org.apache.xml.security.exceptions.XMLSecurityException;
	import org.apache.xpath.XPathAPI;
	import org.w3c.dom.Attr;
	import org.w3c.dom.Document;
	import org.w3c.dom.Element;
	import org.w3c.dom.Node;
	import org.w3c.dom.NodeList;
	import org.w3c.dom.Text;


	/**
	* This is the base class to all Objects which have a direct 1:1 mapping to an
	* Element in a particular namespace.
	*
	* @author $Author$
	*/
	public abstract class ElementProxy {

	/** {@link org.apache.commons.logging} logging facility */
	static org.apache.commons.logging.Log log =
	org.apache.commons.logging.LogFactory.getLog(ElementProxy.class.getName());
	//J-
	public static final int MODE_CREATE = 0;
	public static final int MODE_PROCESS = 1;
	public static final int MODE_UNKNOWN = 2;

	public static final int MODE_SIGN = MODE_CREATE;
	public static final int MODE_VERIFY = MODE_PROCESS;

	public static final int MODE_ENCRYPT = MODE_CREATE;
	public static final int MODE_DECRYPT = MODE_PROCESS;

	protected int _state = MODE_UNKNOWN;
	//J+

	/**
	* Returns the namespace of the Elements of the sub-class.
	*
	* @return the namespace of the Elements of the sub-class.
	*/
	public abstract String getBaseNamespace();

	/**
	* Returns the localname of the Elements of the sub-class.
	*
	* @return the localname of the Elements of the sub-class.
	*/
	public abstract String getBaseLocalName();

	/** Field _constructionElement */
	protected Element _constructionElement = null;

	/** Field _baseURI */
	protected String _baseURI = null;

	/** Field _doc */
	protected Document _doc = null;

	/**
	* Constructor ElementProxy
	*
	*/
	public ElementProxy() {

	this._doc = null;
	this._state = ElementProxy.MODE_UNKNOWN;
	this._baseURI = null;
	this._constructionElement = null;
	}

	/**
	* Constructor ElementProxy
	*
	* @param doc
	*/
	public ElementProxy(Document doc) {

	this();

	if (doc == null) {
	throw new RuntimeException("Document is null");
	}

	this._doc = doc;
	this._state = ElementProxy.MODE_CREATE;
	this._constructionElement = ElementProxy.createElementForFamily(this._doc,
	this.getBaseNamespace(), this.getBaseLocalName());
	}

	/**
	* This method creates an Element in a given namespace with a given localname.
	* It uses the {@link ElementProxy#getDefaultPrefix} method to decide whether
	* a particular prefix is bound to that namespace.
	* <BR />
	* This method was refactored out of the constructor.
	*
	* @param doc
	* @param namespace
	* @param localName
	*
	*/
	public static Element createElementForFamily(Document doc, String namespace,
	String localName) {

	Element result = null;
	String prefix = ElementProxy.getDefaultPrefix(namespace);

	if (namespace == null) {
	result = doc.createElementNS(null, localName);
	} else {
	if ((prefix == null) \|\| (prefix.length() == 0)) {
	result = doc.createElementNS(namespace, localName);

	result.setAttributeNS(Constants.NamespaceSpecNS, "xmlns",
	namespace);
	} else {
	result = doc.createElementNS(namespace, prefix + ":" + localName);

	result.setAttributeNS(Constants.NamespaceSpecNS, "xmlns:" + prefix,
	namespace);
	}
	}

	return result;
	}

	/**
	* Method setElement
	*
	* @param element
	* @param BaseURI
	* @throws XMLSecurityException
	*/
	public void setElement(Element element, String BaseURI)
	throws XMLSecurityException {

	if (element == null) {
	throw new XMLSecurityException("ElementProxy.nullElement");
	}

	log.debug("setElement(" + element.getTagName() + ", \"" + BaseURI + "\"");

	this._doc = element.getOwnerDocument();
	this._state = ElementProxy.MODE_PROCESS;
	this._constructionElement = element;
	this._baseURI = BaseURI;
	}

	/**
	* Constructor ElementProxy
	*
	* @param element
	* @param BaseURI
	* @throws XMLSecurityException
	*/
	public ElementProxy(Element element, String BaseURI)
	throws XMLSecurityException {

	this();

	if (element == null) {
	throw new XMLSecurityException("ElementProxy.nullElement");
	}

	log.debug("setElement(\"" + element.getTagName() + "\", \"" + BaseURI
	+ "\")");

	this._doc = element.getOwnerDocument();
	this._state = ElementProxy.MODE_PROCESS;
	this._constructionElement = element;
	this._baseURI = BaseURI;

	this.guaranteeThatElementInCorrectSpace();
	}

	/**
	* Returns the Element which was constructed by the Object.
	*
	* @return the Element which was constructed by the Object.
	*/
	public final Element getElement() {
	return this._constructionElement;
	}

	/**
	* Returns the Element plus a leading and a trailing CarriageReturn Text node.
	*
	* @return the Element which was constructed by the Object.
	*/
	public final NodeList getElementPlusReturns() {

	HelperNodeList nl = new HelperNodeList();

	nl.appendChild(this._doc.createTextNode("\n"));
	nl.appendChild(this.getElement());
	nl.appendChild(this._doc.createTextNode("\n"));

	return nl;
	}

	/**
	* Method getDocument
	*
	*
	*/
	public Document getDocument() {
	return this._doc;
	}

	/**
	* Method getBaseURI
	*
	*
	*/
	public String getBaseURI() {
	return this._baseURI;
	}

	/**
	* Method guaranteeThatElementInCorrectSpace
	*
	* @throws XMLSecurityException
	*/
	public void guaranteeThatElementInCorrectSpace()
	throws XMLSecurityException {

	String localnameSHOULDBE = this.getBaseLocalName();
	String namespaceSHOULDBE = this.getBaseNamespace();
	String qnameSHOULDBE = "{" + ((namespaceSHOULDBE == null)
	? ""
	: namespaceSHOULDBE) + "}"
	+ localnameSHOULDBE;
	String localnameIS = this._constructionElement.getLocalName();
	String namespaceIS = this._constructionElement.getNamespaceURI();
	String qnameIS = "{" + ((namespaceIS == null)
	? ""
	: namespaceIS) + "}" + localnameIS;

	if (!qnameIS.equals(qnameSHOULDBE)) {
	Object exArgs[] = { qnameSHOULDBE, qnameIS };

	throw new XMLSecurityException("xml.WrongElement", exArgs);
	}
	}

	/**
	* Method setVal
	*
	* @param bi
	* @param localname
	*/
	public void addBigIntegerElement(BigInteger bi, String localname) {

	if (bi != null) {
	Element e = XMLUtils.createElementInSignatureSpace(this._doc,
	localname);

	Base64.fillElementWithBigInteger(e, bi);
	this._constructionElement.appendChild(e);
	XMLUtils.addReturnToElement(this._constructionElement);
	}
	}

	/**
	* Method addBase64Element
	*
	* @param bytes
	* @param localname
	*/
	public void addBase64Element(byte[] bytes, String localname) {

	if (bytes != null) {
	Element e = Base64.encodeToElement(this._doc, localname, bytes);

	this._constructionElement.appendChild(e);
	this._constructionElement.appendChild(this._doc.createTextNode("\n"));
	}
	}

	/**
	* Method addTextElement
	*
	* @param text
	* @param localname
	*/
	public void addTextElement(String text, String localname) {

	Element e = XMLUtils.createElementInSignatureSpace(this._doc, localname);
	Text t = this._doc.createTextNode(text);

	e.appendChild(t);
	this._constructionElement.appendChild(e);
	XMLUtils.addReturnToElement(this._constructionElement);
	}

	/**
	* Method addBase64Text
	*
	* @param bytes
	*/
	public void addBase64Text(byte[] bytes) {

	if (bytes != null) {
	Text t = this._doc.createTextNode("\n" + Base64.encode(bytes) + "\n");

	this._constructionElement.appendChild(t);
	}
	}

	/**
	* Method addText
	*
	* @param text
	*/
	public void addText(String text) {

	if (text != null) {
	Text t = this._doc.createTextNode(text);

	this._constructionElement.appendChild(t);
	}
	}

	/**
	* Method getVal
	*
	* @param localname
	* @param namespace
	*
	* @throws XMLSecurityException
	*/
	public BigInteger getBigIntegerFromChildElement(
	String localname, String namespace) throws XMLSecurityException {

	try {
	Element nscontext = XMLUtils.createDSctx(this._doc, "x", namespace);
	Text t = (Text) XPathAPI.selectSingleNode(this._constructionElement,
	"./x:" + localname
	+ "/text()", nscontext);

	return Base64.decodeBigIntegerFromText(t);
	} catch (TransformerException ex) {
	throw new XMLSecurityException("empty", ex);
	}
	}

	/**
	* Method getBytesFromChildElement
	*
	* @param localname
	* @param namespace
	*
	* @throws XMLSecurityException
	*/
	public byte[] getBytesFromChildElement(String localname, String namespace)
	throws XMLSecurityException {

	try {
	Element nscontext = XMLUtils.createDSctx(this._doc, "x", namespace);
	Element e =
	(Element) XPathAPI.selectSingleNode(this._constructionElement,
	"./x:" + localname, nscontext);

	return Base64.decode(e);
	} catch (TransformerException ex) {
	throw new XMLSecurityException("empty", ex);
	}
	}

	/**
	* Method getTextFromChildElement
	*
	* @param localname
	* @param namespace
	*
	* @throws XMLSecurityException
	*/
	public String getTextFromChildElement(String localname, String namespace)
	throws XMLSecurityException {

	try {
	Element nscontext = XMLUtils.createDSctx(this._doc, "x", namespace);
	Text t = (Text) XPathAPI.selectSingleNode(this._constructionElement,
	"./x:" + localname
	+ "/text()", nscontext);

	return t.getData();
	} catch (TransformerException ex) {
	throw new XMLSecurityException("empty", ex);
	}
	}

	/**
	* Method getBytesFromTextChild
	*
	*
	* @throws XMLSecurityException
	*/
	public byte[] getBytesFromTextChild() throws XMLSecurityException {

	try {
	Text t = (Text) XPathAPI.selectSingleNode(this._constructionElement,
	"./text()");

	return Base64.decode(t.getData());
	} catch (TransformerException ex) {
	throw new XMLSecurityException("empty", ex);
	}
	}

	/**
	* Method getTextFromTextChild
	*
	*
	*/
	public String getTextFromTextChild() {
	return XMLUtils.getFullTextChildrenFromElement(this._constructionElement);
	}

	/**
	* This method returns the index'th child with the given namespace
	* and localname.
	*
	* @param index
	* @param namespace
	* @param localname
	* @return null if the Element does not contain the requested child
	*/
	public Element getChildElementLocalName(int index, String namespace,
	String localname) {

	NodeList childNodes = this._constructionElement.getChildNodes();
	int maxLength = childNodes.getLength();
	int result = -1;

	for (int i = 0; i < maxLength; i++) {
	Node n = childNodes.item(i);

	if (n.getNodeType() == Node.ELEMENT_NODE) {
	String ns = n.getNamespaceURI();
	String name = n.getLocalName();

	if (((namespace != null) && (ns != null) && namespace.equals(ns))
	\|\| ((namespace == null) && (ns == null))) {
	if (localname.equals(name)) {
	result++;

	if (result == index) {
	return (Element) n;
	}
	}
	}
	}
	}

	// throw new IndexOutOfBoundsException("Try to get " + index + "/" + maxLength + " {" + namespace + "}" + localname + " from " + this._constructionElement.getTagName());
	return null;
	}

	/**
	* Method length
	*
	* @param namespace
	* @param localname
	*
	*/
	public int length(String namespace, String localname) {

	NodeList childNodes = this._constructionElement.getChildNodes();
	int maxLength = childNodes.getLength();
	int result = 0;

	for (int i = 0; i < maxLength; i++) {
	Node n = childNodes.item(i);

	if (n.getNodeType() == Node.ELEMENT_NODE) {
	String ns = n.getNamespaceURI();
	String name = n.getLocalName();

	if (((namespace != null) && (ns != null) && namespace.equals(ns))
	\|\| ((namespace == null) && (ns == null))) {
	if (localname.equals(name)) {
	result++;
	}
	}
	}
	}

	return result;
	}

	/**
	* Adds an xmlns: definition to the Element. This can be called as follows:
	*
	* <PRE>
	* // set namespace with ds prefix
	* xpathContainer.setXPathNamespaceContext("ds", "http://www.w3.org/2000/09/xmldsig#");
	* xpathContainer.setXPathNamespaceContext("xmlns:ds", "http://www.w3.org/2000/09/xmldsig#");
	* </PRE>
	*
	* @param prefix
	* @param uri
	* @throws XMLSecurityException
	*/
	public void setXPathNamespaceContext(String prefix, String uri)
	throws XMLSecurityException {

	String ns;

	if ((prefix == null) \|\| (prefix.length() == 0)) {
	ns = "xmlns";
	} else if (prefix.equals("xmlns")) {
	ns = "xmlns";
	} else if (prefix.startsWith("xmlns:")) {
	ns = "xmlns:" + prefix.substring("xmlns:".length());
	} else {
	ns = "xmlns:" + prefix;
	}

	if (ns.equals("xmlns")) {
	throw new XMLSecurityException("defaultNamespaceCannotBeSetHere");
	}

	Attr a = this._constructionElement.getAttributeNodeNS(Constants.NamespaceSpecNS, ns);

	if ((a != null) && (!a.getNodeValue().equals(uri))) {
	Object exArgs[] = { ns,
	this._constructionElement.getAttributeNS(null,
	ns) };

	throw new XMLSecurityException("namespacePrefixAlreadyUsedByOtherURI",
	exArgs);
	}

	this._constructionElement.setAttributeNS(Constants.NamespaceSpecNS, ns,
	uri);
	}

	/** Field _prefixMappings */
	static HashMap _prefixMappings = new HashMap();

	/**
	* Method setDefaultPrefix
	*
	* @param namespace
	* @param prefix
	* @throws XMLSecurityException
	*/
	public static void setDefaultPrefix(String namespace, String prefix)
	throws XMLSecurityException {

	Iterator keys = ElementProxy._prefixMappings.keySet().iterator();

	while (keys.hasNext()) {
	String storedNamespace = (String) keys.next();
	String storedPrefix =
	(String) ElementProxy._prefixMappings.get(storedNamespace);

	if (storedPrefix.equals(prefix) &&!storedNamespace.equals(namespace)) {
	Object exArgs[] = { prefix, namespace, storedNamespace };

	throw new XMLSecurityException("prefix.AlreadyAssigned", exArgs);
	}
	}

	ElementProxy._prefixMappings.put(namespace, prefix);
	}

	/**
	* Method getDefaultPrefix
	*
	* @param namespace
	*
	*/
	public static String getDefaultPrefix(String namespace) {

	String prefix = (String) ElementProxy._prefixMappings.get(namespace);

	return prefix;
	}
	}