play.libs

Class XML

java.lang.Object

play.libs.XML

public class XML
extends Object

XML utils

Constructor Summary

Constructors

Constructor and Description
XML()

Method Summary

Modifier and Type	Method and Description
static Document	getDocument(File file) Parse an XML file to DOM
static Document	getDocument(InputStream stream) Parse an XML coming from an input stream to DOM
static Document	getDocument(String xml) Parse an XML string content to DOM
static DocumentBuilder	newDocumentBuilder()
static DocumentBuilderFactory	newDocumentBuilderFactory()
static String	serialize(Document document) Serialize to XML String
static Document	sign(Document document, RSAPublicKey publicKey, RSAPrivateKey privateKey) Sign the XML document using xmldsig.
static boolean	validSignature(Document document, Key publicKey) Check the xmldsig signature of the XML document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XML

public XML()

Method Detail

newDocumentBuilderFactory

public static DocumentBuilderFactory newDocumentBuilderFactory()

newDocumentBuilder

public static DocumentBuilder newDocumentBuilder()

serialize

public static String serialize(Document document)

Serialize to XML String

Parameters:

document - The DOM document

Returns:

The XML String

getDocument

public static Document getDocument(File file)

Parse an XML file to DOM

Returns:

null if an error occurs during parsing.

getDocument

public static Document getDocument(String xml)

Parse an XML string content to DOM

Returns:

null if an error occurs during parsing.

getDocument

public static Document getDocument(InputStream stream)

Parse an XML coming from an input stream to DOM

Returns:

null if an error occurs during parsing.

validSignature

public static boolean validSignature(Document document,
                                     Key publicKey)

Check the xmldsig signature of the XML document.

Parameters:

document - the document to test

publicKey - the public key corresponding to the key pair the document was signed with

Returns:

true if a correct signature is present, false otherwise

sign

public static Document sign(Document document,
                            RSAPublicKey publicKey,
                            RSAPrivateKey privateKey)

Sign the XML document using xmldsig.

Parameters:

document - the document to sign; it will be modified by the method.

publicKey - the public key from the key pair to sign the document.

privateKey - the private key from the key pair to sign the document.

Returns:

the signed document for chaining.