javax.xml.crypto.dsig.dom.DOMValidateContext Maven / Gradle / Ivy
Show all versions of xmlsec Show documentation
/**
* 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: DOMValidateContext.java 1092655 2011-04-15 10:24:18Z coheigea $
*/
package javax.xml.crypto.dsig.dom;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.dom.DOMCryptoContext;
import javax.xml.crypto.dsig.XMLSignature;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.XMLValidateContext;
import java.security.Key;
import org.w3c.dom.Node;
/**
* A DOM-specific {@link XMLValidateContext}. This class contains additional
* methods to specify the location in a DOM tree where an {@link XMLSignature}
* is to be unmarshalled and validated from.
*
* Note that the behavior of an unmarshalled XMLSignature
* is undefined if the contents of the underlying DOM tree are modified by the
* caller after the XMLSignature is created.
*
*
Also, note that DOMValidateContext instances can contain
* information and state specific to the XML signature structure it is
* used with. The results are unpredictable if a
* DOMValidateContext is used with different signature structures
* (for example, you should not use the same DOMValidateContext
* instance to validate two different {@link XMLSignature} objects).
*
* @author Sean Mullan
* @author JSR 105 Expert Group
* @see XMLSignatureFactory#unmarshalXMLSignature(XMLValidateContext)
*/
public class DOMValidateContext extends DOMCryptoContext
implements XMLValidateContext {
private Node node;
/**
* Creates a DOMValidateContext containing the specified key
* selector and node.
*
* @param ks a key selector for finding a validation key
* @param node the node
* @throws NullPointerException if ks or node is
* null
*/
public DOMValidateContext(KeySelector ks, Node node) {
if (ks == null) {
throw new NullPointerException("key selector is null");
}
if (node == null) {
throw new NullPointerException("node is null");
}
setKeySelector(ks);
this.node = node;
}
/**
* Creates a DOMValidateContext containing the specified key
* and node. The validating key will be stored in a
* {@link KeySelector#singletonKeySelector singleton KeySelector} that
* is returned when the {@link #getKeySelector getKeySelector}
* method is called.
*
* @param validatingKey the validating key
* @param node the node
* @throws NullPointerException if validatingKey or
* node is null
*/
public DOMValidateContext(Key validatingKey, Node node) {
if (validatingKey == null) {
throw new NullPointerException("validatingKey is null");
}
if (node == null) {
throw new NullPointerException("node is null");
}
setKeySelector(KeySelector.singletonKeySelector(validatingKey));
this.node = node;
}
/**
* Sets the node.
*
* @param node the node
* @throws NullPointerException if node is null
* @see #getNode
*/
public void setNode(Node node) {
if (node == null) {
throw new NullPointerException();
}
this.node = node;
}
/**
* Returns the node.
*
* @return the node (never null)
* @see #setNode(Node)
*/
public Node getNode() {
return node;
}
}