org.apache.jcp.xml.dsig.internal.dom.DOMSignatureProperty Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xmlsec Show documentation
Show all versions of xmlsec Show documentation
Apache XML Security for Java supports XML-Signature Syntax and Processing,
W3C Recommendation 12 February 2002, and XML Encryption Syntax and
Processing, W3C Recommendation 10 December 2002. As of version 1.4,
the library supports the standard Java API JSR-105: XML Digital Signature APIs.
/**
* 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: DOMSignatureProperty.java 1585385 2014-04-07 05:12:23Z coheigea $
*/
package org.apache.jcp.xml.dsig.internal.dom;
import javax.xml.crypto.*;
import javax.xml.crypto.dsig.*;
import java.util.*;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/**
* DOM-based implementation of SignatureProperty.
*
* @author Sean Mullan
*/
public final class DOMSignatureProperty extends BaseStructure
implements SignatureProperty {
private final String id;
private final String target;
private final List content;
/**
* Creates a SignatureProperty from the specified parameters.
*
* @param content a list of one or more {@link XMLStructure}s. The list
* is defensively copied to protect against subsequent modification.
* @param target the target URI
* @param id the Id (may be null)
* @throws ClassCastException if content contains any
* entries that are not of type {@link XMLStructure}
* @throws IllegalArgumentException if content is empty
* @throws NullPointerException if content or
* target is null
*/
public DOMSignatureProperty(List content,
String target, String id)
{
if (target == null) {
throw new NullPointerException("target cannot be null");
} else if (content == null) {
throw new NullPointerException("content cannot be null");
} else if (content.isEmpty()) {
throw new IllegalArgumentException("content cannot be empty");
} else {
this.content = Collections.unmodifiableList(
new ArrayList(content));
for (int i = 0, size = this.content.size(); i < size; i++) {
if (!(this.content.get(i) instanceof XMLStructure)) {
throw new ClassCastException
("content["+i+"] is not a valid type");
}
}
}
this.target = target;
this.id = id;
}
/**
* Creates a DOMSignatureProperty from an element.
*
* @param propElem a SignatureProperty element
*/
public DOMSignatureProperty(Element propElem)
throws MarshalException
{
// unmarshal attributes
target = DOMUtils.getAttributeValue(propElem, "Target");
if (target == null) {
throw new MarshalException("target cannot be null");
}
id = DOMUtils.getIdAttributeValue(propElem, "Id");
NodeList nodes = propElem.getChildNodes();
int length = nodes.getLength();
List content = new ArrayList(length);
for (int i = 0; i < length; i++) {
content.add(new javax.xml.crypto.dom.DOMStructure(nodes.item(i)));
}
if (content.isEmpty()) {
throw new MarshalException("content cannot be empty");
} else {
this.content = Collections.unmodifiableList(content);
}
}
@Override
public List getContent() {
return content;
}
@Override
public String getId() {
return id;
}
@Override
public String getTarget() {
return target;
}
public static void marshal(XmlWriter xwriter, SignatureProperty sigProp, String dsPrefix, XMLCryptoContext context)
throws MarshalException
{
xwriter.writeStartElement(dsPrefix, "SignatureProperty", XMLSignature.XMLNS);
// set attributes
xwriter.writeIdAttribute("", "", "Id", sigProp.getId());
xwriter.writeAttribute("", "", "Target", sigProp.getTarget());
// create and append any elements and mixed content
List content = getContent(sigProp);
for (XMLStructure property : content) {
xwriter.marshalStructure(property, dsPrefix, context);
}
xwriter.writeEndElement(); // "SignatureProperty"
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof SignatureProperty)) {
return false;
}
SignatureProperty osp = (SignatureProperty)o;
boolean idsEqual = id == null ? osp.getId() == null
: id.equals(osp.getId());
@SuppressWarnings("unchecked")
List ospContent = osp.getContent();
return equalsContent(ospContent) &&
target.equals(osp.getTarget()) && idsEqual;
}
@Override
public int hashCode() {
int result = 17;
if (id != null) {
result = 31 * result + id.hashCode();
}
result = 31 * result + target.hashCode();
result = 31 * result + content.hashCode();
return result;
}
@SuppressWarnings("unchecked")
private static List getContent(SignatureProperty prop) {
return prop.getContent();
}
private boolean equalsContent(List otherContent) {
int osize = otherContent.size();
if (content.size() != osize) {
return false;
}
for (int i = 0; i < osize; i++) {
XMLStructure oxs = otherContent.get(i);
XMLStructure xs = content.get(i);
if (oxs instanceof javax.xml.crypto.dom.DOMStructure) {
if (!(xs instanceof javax.xml.crypto.dom.DOMStructure)) {
return false;
}
Node onode = ((javax.xml.crypto.dom.DOMStructure)oxs).getNode();
Node node = ((javax.xml.crypto.dom.DOMStructure)xs).getNode();
if (!DOMUtils.nodesEqual(node, onode)) {
return false;
}
} else {
if (!(xs.equals(oxs))) {
return false;
}
}
}
return true;
}
}