1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
/* * Copyright 2006 Sun Microsystems, Inc. All rights reserved. */ /* * $Id: DOMSignContext.java,v 1.9 2005/05/10 16:31:14 mullan Exp $ */ package javax.xml.crypto.dsig.dom; import javax.xml.crypto.KeySelector; import javax.xml.crypto.dom.DOMCryptoContext; import javax.xml.crypto.dsig.XMLSignContext; import javax.xml.crypto.dsig.XMLSignature; import java.security.Key; import org.w3c.dom.Node; /** * A DOM-specific {@link XMLSignContext}. This class contains additional methods * to specify the location in a DOM tree where an {@link XMLSignature} * object is to be marshalled when generating the signature. * * <p>Note that <code>DOMSignContext</code> instances can contain * information and state specific to the XML signature structure it is * used with. The results are unpredictable if a * <code>DOMSignContext</code> is used with different signature structures * (for example, you should not use the same <code>DOMSignContext</code> * instance to sign two different {@link XMLSignature} objects). * * @author Sean Mullan * @author JSR 105 Expert Group * @since 1.6 */ public class DOMSignContext extends DOMCryptoContext implements XMLSignContext { private Node parent; private Node nextSibling; /** * Creates a <code>DOMSignContext</code> with the specified signing key * and parent node. The signing key is stored in a * {@link KeySelector#singletonKeySelector singleton KeySelector} that is * returned by the {@link #getKeySelector getKeySelector} method. * The marshalled <code>XMLSignature</code> will be added as the last * child element of the specified parent node unless a next sibling node is * specified by invoking the {@link #setNextSibling setNextSibling} method. * * @param signingKey the signing key * @param parent the parent node * @throws NullPointerException if <code>signingKey</code> or * <code>parent</code> is <code>null</code> */ public DOMSignContext(Key signingKey, Node parent) { if (signingKey == null) { throw new NullPointerException("signingKey cannot be null"); } if (parent == null) { throw new NullPointerException("parent cannot be null"); } setKeySelector(KeySelector.singletonKeySelector(signingKey)); this.parent = parent; } /** * Creates a <code>DOMSignContext</code> with the specified signing key, * parent and next sibling nodes. The signing key is stored in a * {@link KeySelector#singletonKeySelector singleton KeySelector} that is * returned by the {@link #getKeySelector getKeySelector} method. * The marshalled <code>XMLSignature</code> will be inserted as a child * element of the specified parent node and immediately before the * specified next sibling node. * * @param signingKey the signing key * @param parent the parent node * @param nextSibling the next sibling node * @throws NullPointerException if <code>signingKey</code>, * <code>parent</code> or <code>nextSibling</code> is <code>null</code> */ public DOMSignContext(Key signingKey, Node parent, Node nextSibling) { if (signingKey == null) { throw new NullPointerException("signingKey cannot be null"); } if (parent == null) { throw new NullPointerException("parent cannot be null"); } if (nextSibling == null) { throw new NullPointerException("nextSibling cannot be null"); } setKeySelector(KeySelector.singletonKeySelector(signingKey)); this.parent = parent; this.nextSibling = nextSibling; } /** * Creates a <code>DOMSignContext</code> with the specified key selector * and parent node. The marshalled <code>XMLSignature</code> will be added * as the last child element of the specified parent node unless a next * sibling node is specified by invoking the * {@link #setNextSibling setNextSibling} method. * * @param ks the key selector * @param parent the parent node * @throws NullPointerException if <code>ks</code> or <code>parent</code> * is <code>null</code> */ public DOMSignContext(KeySelector ks, Node parent) { if (ks == null) { throw new NullPointerException("key selector cannot be null"); } if (parent == null) { throw new NullPointerException("parent cannot be null"); } setKeySelector(ks); this.parent = parent; } /** * Creates a <code>DOMSignContext</code> with the specified key selector, * parent and next sibling nodes. The marshalled <code>XMLSignature</code> * will be inserted as a child element of the specified parent node and * immediately before the specified next sibling node. * * @param ks the key selector * @param parent the parent node * @param nextSibling the next sibling node * @throws NullPointerException if <code>ks</code>, <code>parent</code> or * <code>nextSibling</code> is <code>null</code> */ public DOMSignContext(KeySelector ks, Node parent, Node nextSibling) { if (ks == null) { throw new NullPointerException("key selector cannot be null"); } if (parent == null) { throw new NullPointerException("parent cannot be null"); } if (nextSibling == null) { throw new NullPointerException("nextSibling cannot be null"); } setKeySelector(ks); this.parent = parent; this.nextSibling = nextSibling; } /** * Sets the parent node. * * @param parent the parent node. The marshalled <code>XMLSignature</code> * will be added as a child element of this node. * @throws NullPointerException if <code>parent</code> is <code>null</code> * @see #getParent */ public void setParent(Node parent) { if (parent == null) { throw new NullPointerException("parent is null"); } this.parent = parent; } /** * Sets the next sibling node. * * @param nextSibling the next sibling node. The marshalled * <code>XMLSignature</code> will be inserted immediately before this * node. Specify <code>null</code> to remove the current setting. * @see #getNextSibling */ public void setNextSibling(Node nextSibling) { this.nextSibling = nextSibling; } /** * Returns the parent node. * * @return the parent node (never <code>null</code>) * @see #setParent(Node) */ public Node getParent() { return parent; } /** * Returns the nextSibling node. * * @return the nextSibling node, or <code>null</code> if not specified. * @see #setNextSibling(Node) */ public Node getNextSibling() { return nextSibling; } }