org.jboss.as.patching.generator

Interface PatchConfig

public interface PatchConfig

Configuration for generating a patch.

Author:

Brian Stansberry (c) 2012 Red Hat Inc.

Method Summary

Modifier and Type	Method and Description
String	getAppliesToProduct() Get the product name this patch applies to.
String	getAppliesToVersion() Get the applies to version.
String	getDescription() Get the patch description.
Collection<PatchElementConfig>	getElements() Get the configuration for each element.
Set<String>	getInRuntimeUseItems() Get the miscellaneous content item that will be in active use on a target process that isn't in admin-only mode.
Collection<OptionalPath>	getOptionalPaths() Returns a collection of optional paths.
String	getPatchId() Get the unique patch ID.
org.jboss.as.patching.metadata.Patch.PatchType	getPatchType() Get the patch type.
String	getResultingVersion() Get the resulting version for cumulative patches.
Set<org.jboss.as.patching.metadata.ContentItem>	getSpecifiedContent() Gets the modifications specifically specified in the patch config, if the config doesn't specify generating the modifications by differencing the two distributions.
boolean	isGenerateByDiff() Gets whether the patch.xml should be generated by differencing the two distributions.
org.jboss.as.patching.generator.PatchBuilderWrapper	toPatchBuilder() Create a PatchBuilderWrapper whose basic metadata matches what's configured in this object.

Method Detail

getPatchId

String getPatchId()

Get the unique patch ID.

Returns:

the patch id

getDescription

String getDescription()

Get the patch description.

Returns:

the patch description

getPatchType

org.jboss.as.patching.metadata.Patch.PatchType getPatchType()

Get the patch type.

Returns:

the type of the patch

getAppliesToProduct

String getAppliesToProduct()

Get the product name this patch applies to.

Returns:

the product name

getAppliesToVersion

String getAppliesToVersion()

Get the applies to version.

Returns:

the applies to

getResultingVersion

String getResultingVersion()

Get the resulting version for cumulative patches.

Returns:

the resulting version

getInRuntimeUseItems

Set<String> getInRuntimeUseItems()

Get the miscellaneous content item that will be in active use on a target process that isn't in admin-only mode.

Returns:

the items. Will not return null

isGenerateByDiff

boolean isGenerateByDiff()

Gets whether the patch.xml should be generated by differencing the two distributions.

Returns:

true if the patch.xml should be generated, false if they have been specified in the patch config document

getSpecifiedContent

Set<org.jboss.as.patching.metadata.ContentItem> getSpecifiedContent()

Gets the modifications specifically specified in the patch config, if the config doesn't specify generating the modifications by differencing the two distributions.

Returns:

the modified content items

getElements

Collection<PatchElementConfig> getElements()

Get the configuration for each element.

Returns:

the patch elements

getOptionalPaths

Collection<OptionalPath> getOptionalPaths()

Returns a collection of optional paths. I.e. filesystem paths for which patch updates should be generated and included but that might be missing in the target installation and in that case be skipped instead of aborting the whole patch altogether.

Returns:

optional paths

toPatchBuilder

org.jboss.as.patching.generator.PatchBuilderWrapper toPatchBuilder()

Create a PatchBuilderWrapper whose basic metadata matches what's configured in this object.

Returns:

the patch builder