org.rhq.common.wildfly

Class PatchParser

java.lang.Object

org.rhq.common.wildfly.PatchParser

public final class PatchParser
extends Object

A simple parser of the Wildfly patch files. Can be used only to find a limited set of metadata about the patches.

Since:

4.13

Author:

Lukas Krejci

Method Summary

Methods

Modifier and Type	Method and Description
static PatchInfo	parse(InputStream patchContents, boolean captureDescriptors) Tries to find if the provided input stream is a Wildfly patch file and return information about the patch parsed out of it.

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static PatchInfo parse(InputStream patchContents,
              boolean captureDescriptors)
                       throws IOException,
                              XMLStreamException

Tries to find if the provided input stream is a Wildfly patch file and return information about the patch parsed out of it. This method assumes that the provided input stream is the contents of a ZIP file.

The stream is not closed after this method returns.

Parameters:

patchContents - the contents of the patch file

captureDescriptors - whether to store the full contents of the patch XML descriptors in the returned info

Returns:

the info about the patch or null if the stream is not a patch file

Throws:

IOException - on IO error or if the stream is not in a valid ZIP format

XMLStreamException - on error parsing XML patch descriptors (patch.xml or patches.xml files inside the ZIP)