javax.xml.crypto.dsig.dom.DOMSignContext Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* Copyright 2005 Sun Microsystems, Inc. All rights reserved.
*/
/*
* $Id$
*/
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.
*
* Note that DOMSignContext instances can contain
* information and state specific to the XML signature structure it is
* used with. The results are unpredictable if a
* DOMSignContext is used with different signature structures
* (for example, you should not use the same DOMSignContext
* instance to sign two different {@link XMLSignature} objects).
*
* @author Sean Mullan
* @author JSR 105 Expert Group
*/
public class DOMSignContext extends DOMCryptoContext implements XMLSignContext {
private Node parent;
private Node nextSibling;
/**
* Creates a DOMSignContext 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 XMLSignature 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 signingKey or
* parent is null
*/
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 DOMSignContext 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 XMLSignature 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 signingKey,
* parent or nextSibling is null
*/
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 DOMSignContext with the specified key selector
* and parent node. The marshalled XMLSignature 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 ks or parent
* is null
*/
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 DOMSignContext with the specified key selector,
* parent and next sibling nodes. The marshalled XMLSignature
* 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 ks, parent or
* nextSibling is null
*/
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 XMLSignature
* will be added as a child element of this node.
* @throws NullPointerException if parent is null
* @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
* XMLSignature will be inserted immediately before this
* node. Specify null to remove the current setting.
* @see #getNextSibling
*/
public void setNextSibling(Node nextSibling) {
this.nextSibling = nextSibling;
}
/**
* Returns the parent node.
*
* @return the parent node (never null)
* @see #setParent(Node)
*/
public Node getParent() {
return parent;
}
/**
* Returns the nextSibling node.
*
* @return the nextSibling node, or null if not specified.
* @see #setNextSibling(Node)
*/
public Node getNextSibling() {
return nextSibling;
}
}