org.jboss.as.patching.tool

Interface PatchTool

All Known Implementing Classes:

PatchToolImpl

public interface PatchTool

The patch tool.

Author:

Emanuel Muckenhuber

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PatchTool.ContentPolicyBuilder
static class	PatchTool.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static ContentVerificationPolicy	DEFAULT

Method Summary

Modifier and Type	Method and Description
PatchingResult	applyPatch(File file, ContentVerificationPolicy contentPolicy) Apply a patch.
PatchingResult	applyPatch(InputStream is, ContentVerificationPolicy contentPolicy) Apply a patch.
PatchingResult	applyPatch(URL url, ContentVerificationPolicy contentPolicy) Apply a patch.
PatchInfo	getPatchInfo() Get the patch info.
PatchingHistory	getPatchingHistory() Get patching history
PatchingResult	rollback(String patchId, ContentVerificationPolicy contentPolicy, boolean rollbackTo, boolean resetConfiguration) Rollback a patch.
PatchingResult	rollbackLast(ContentVerificationPolicy contentPolicy, boolean resetConfiguration) Rollback the last applied patch.

Field Detail

DEFAULT

static final ContentVerificationPolicy DEFAULT

Method Detail

getPatchInfo

PatchInfo getPatchInfo()

Get the patch info.

Returns:

the patch info

getPatchingHistory

PatchingHistory getPatchingHistory()

Get patching history

Returns:

patching history

applyPatch

PatchingResult applyPatch(File file,
                          ContentVerificationPolicy contentPolicy)
                   throws PatchingException

Apply a patch.

Parameters:

file - the patch file

contentPolicy - the content verification policy

Returns:

the patching result

Throws:

PatchingException

applyPatch

PatchingResult applyPatch(URL url,
                          ContentVerificationPolicy contentPolicy)
                   throws PatchingException

Apply a patch.

Parameters:

url - the url to retrieve the patch from

contentPolicy - the content verification policy

Returns:

the patching result

Throws:

PatchingException

applyPatch

PatchingResult applyPatch(InputStream is,
                          ContentVerificationPolicy contentPolicy)
                   throws PatchingException

Apply a patch.

Parameters:

is - the content input stream

contentPolicy - the content verification policy

Returns:

the patching result

Throws:

PatchingException

rollback

PatchingResult rollback(String patchId,
                        ContentVerificationPolicy contentPolicy,
                        boolean rollbackTo,
                        boolean resetConfiguration)
                 throws PatchingException

Rollback a patch.

Parameters:

patchId - the patch id

contentPolicy - the content verification policy

rollbackTo - rollback all one off patches until the given patch-id

resetConfiguration - whether to reset the configuration from the backup

Returns:

the patching result

Throws:

PatchingException

rollbackLast

PatchingResult rollbackLast(ContentVerificationPolicy contentPolicy,
                            boolean resetConfiguration)
                     throws PatchingException

Rollback the last applied patch.

Parameters:

contentPolicy - the content verification policy

resetConfiguration - whether to reset the configuration from the backup

Returns:

the patching result

Throws:

PatchingException