J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | /* |
| 26 | * $Id: DOMStructure.java,v 1.6 2005/05/09 18:33:26 mullan Exp $ |
| 27 | */ |
| 28 | package javax.xml.crypto.dom; |
| 29 | |
| 30 | import org.w3c.dom.Node; |
| 31 | import javax.xml.crypto.XMLStructure; |
| 32 | import javax.xml.crypto.dsig.XMLSignature; |
| 33 | |
| 34 | /** |
| 35 | * A DOM-specific {@link XMLStructure}. The purpose of this class is to |
| 36 | * allow a DOM node to be used to represent extensible content (any elements |
| 37 | * or mixed content) in XML Signature structures. |
| 38 | * |
| 39 | * <p>If a sequence of nodes is needed, the node contained in the |
| 40 | * <code>DOMStructure</code> is the first node of the sequence and successive |
| 41 | * nodes can be accessed by invoking {@link Node#getNextSibling}. |
| 42 | * |
| 43 | * <p>If the owner document of the <code>DOMStructure</code> is different than |
| 44 | * the target document of an <code>XMLSignature</code>, the |
| 45 | * {@link XMLSignature#sign(XMLSignContext)} method imports the node into the |
| 46 | * target document before generating the signature. |
| 47 | * |
| 48 | * @author Sean Mullan |
| 49 | * @author JSR 105 Expert Group |
| 50 | * @since 1.6 |
| 51 | */ |
| 52 | public class DOMStructure implements XMLStructure { |
| 53 | |
| 54 | private final Node node; |
| 55 | |
| 56 | /** |
| 57 | * Creates a <code>DOMStructure</code> containing the specified node. |
| 58 | * |
| 59 | * @param node the node |
| 60 | * @throws NullPointerException if <code>node</code> is <code>null</code> |
| 61 | */ |
| 62 | public DOMStructure(Node node) { |
| 63 | if (node == null) { |
| 64 | throw new NullPointerException("node cannot be null"); |
| 65 | } |
| 66 | this.node = node; |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Returns the node contained in this <code>DOMStructure</code>. |
| 71 | * |
| 72 | * @return the node |
| 73 | */ |
| 74 | public Node getNode() { |
| 75 | return node; |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * @throws NullPointerException {@inheritDoc} |
| 80 | */ |
| 81 | public boolean isFeatureSupported(String feature) { |
| 82 | if (feature == null) { |
| 83 | throw new NullPointerException(); |
| 84 | } else { |
| 85 | return false; |
| 86 | } |
| 87 | } |
| 88 | } |