org.apache.jcp.xml.dsig.internal.dom.DOMXMLObject 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: DOMXMLObject.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.security.Provider;
import java.util.*;
import org.w3c.dom.Attr;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/**
* DOM-based implementation of XMLObject.
*
* @author Sean Mullan
*/
public final class DOMXMLObject extends BaseStructure implements XMLObject {
private final String id;
private final String mimeType;
private final String encoding;
private final List content;
/**
* Creates an XMLObject from the specified parameters.
*
* @param content a list of {@link XMLStructure}s. The list
* is defensively copied to protect against subsequent modification.
* May be null or empty.
* @param id the Id (may be null)
* @param mimeType the mime type (may be null)
* @param encoding the encoding (may be null)
* @throws ClassCastException if content contains any
* entries that are not of type {@link XMLStructure}
*/
public DOMXMLObject(List content, String id,
String mimeType, String encoding)
{
if (content == null || content.isEmpty()) {
this.content = Collections.emptyList();
} 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.id = id;
this.mimeType = mimeType;
this.encoding = encoding;
}
/**
* Creates an XMLObject from an element.
*
* @param objElem an Object element
* @throws MarshalException if there is an error when unmarshalling
*/
public DOMXMLObject(Element objElem, XMLCryptoContext context,
Provider provider)
throws MarshalException
{
// unmarshal attributes
this.encoding = DOMUtils.getAttributeValue(objElem, "Encoding");
Attr attr = objElem.getAttributeNodeNS(null, "Id");
if (attr != null) {
this.id = attr.getValue();
objElem.setIdAttributeNode(attr, true);
} else {
this.id = null;
}
this.mimeType = DOMUtils.getAttributeValue(objElem, "MimeType");
NodeList nodes = objElem.getChildNodes();
int length = nodes.getLength();
List content = new ArrayList(length);
for (int i = 0; i < length; i++) {
Node child = nodes.item(i);
if (child.getNodeType() == Node.ELEMENT_NODE) {
Element childElem = (Element)child;
String tag = childElem.getLocalName();
if (tag.equals("Manifest")) {
content.add(new DOMManifest(childElem, context, provider));
continue;
} else if (tag.equals("SignatureProperties")) {
content.add(new DOMSignatureProperties(childElem));
continue;
} else if (tag.equals("X509Data")) {
content.add(new DOMX509Data(childElem));
continue;
}
//@@@FIXME: check for other dsig structures
}
content.add(new javax.xml.crypto.dom.DOMStructure(child));
}
// Here we capture namespace declarations, so that when they're marshalled back
// out, we can make copies of them. Note that attributes are NOT captured.
NamedNodeMap nnm = objElem.getAttributes();
for (int idx = 0 ; idx < nnm.getLength() ; idx++) {
Node nsDecl = nnm.item(idx);
if (DOMUtils.isNamespace(nsDecl)) {
content.add(new javax.xml.crypto.dom.DOMStructure(nsDecl));
}
}
if (content.isEmpty()) {
this.content = Collections.emptyList();
} else {
this.content = Collections.unmodifiableList(content);
}
}
@Override
public List getContent() {
return content;
}
@Override
public String getId() {
return id;
}
@Override
public String getMimeType() {
return mimeType;
}
@Override
public String getEncoding() {
return encoding;
}
public static void marshal(XmlWriter xwriter, XMLObject xmlObj, String dsPrefix, XMLCryptoContext context)
throws MarshalException {
xwriter.writeStartElement(dsPrefix, "Object", XMLSignature.XMLNS);
// set attributes
xwriter.writeIdAttribute("", "", "Id", xmlObj.getId());
xwriter.writeAttribute("", "", "MimeType", xmlObj.getMimeType());
xwriter.writeAttribute("", "", "Encoding", xmlObj.getEncoding());
// create and append any elements and mixed content, if necessary
@SuppressWarnings("unchecked")
List content = xmlObj.getContent();
for (XMLStructure object : content) {
xwriter.marshalStructure(object, dsPrefix, context);
}
xwriter.writeEndElement(); // "Object"
}
@SuppressWarnings("unchecked")
public static List getXmlObjectContent(XMLObject xo) {
return xo.getContent();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof XMLObject)) {
return false;
}
XMLObject oxo = (XMLObject)o;
boolean idsEqual = id == null ? oxo.getId() == null
: id.equals(oxo.getId());
boolean encodingsEqual =
encoding == null ? oxo.getEncoding() == null
: encoding.equals(oxo.getEncoding());
boolean mimeTypesEqual =
mimeType == null ? oxo.getMimeType() == null
: mimeType.equals(oxo.getMimeType());
return idsEqual && encodingsEqual && mimeTypesEqual &&
equalsContent(getXmlObjectContent(oxo));
}
@Override
public int hashCode() {
int result = 17;
if (id != null) {
result = 31 * result + id.hashCode();
}
if (encoding != null) {
result = 31 * result + encoding.hashCode();
}
if (mimeType != null) {
result = 31 * result + mimeType.hashCode();
}
result = 31 * result + content.hashCode();
return result;
}
private boolean equalsContent(List otherContent) {
if (content.size() != otherContent.size()) {
return false;
}
for (int i = 0, osize = otherContent.size(); 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;
}
}