org.alfresco.repo.admin.patch
Interface Patch
- All Known Implementing Classes:
- AbstractPatch, AbstractPermissionChangePatch, ActionRuleDecouplingPatch, AuthorityDefaultZonesPatch, AuthorityMigrationPatch, AVMFormsPropertyTokenisationPatch, AVMGuidPatch, AVMLayeredSnapshotPatch, AVMLockingPatch, AVMPermissionDataPatch, AVMStorePropertyTokenisationPatch, AVMWebProjectInheritPermissionsPatch, BaseReindexingPatch, CalendarModelUriPatch, CategoryRootPermissionPatch, ContentFormTypePatch, ContentPermissionPatch, ContentUrlConverterPatch, DeploymentMigrationPatch, DescriptorUpdatePatch, DmPermissionsPatch, EmailTemplatesContentPatch, EmailTemplatesFolderPatch, EmailTemplatesInviteAndNotifyFoldersPatch, FixNameCrcValuesPatch, ForumsIconsPatch, GenericBootstrapPatch, GenericWorkflowPatch, GroupTokenisationPatch, GuestPersonPermissionPatch, GuestPersonPermissionPatch2, GuestUserPatch, ImapFoldersPatch, InvalidNameEndingPatch, InvalidUserPersonAndGroupPatch, InvitationMigrationPatch, LinkNodeFileExtensionPatch, MigrateVersionStorePatch, MoveWCMToGroupBasedPermissionsPatch, MultiTShareExistingTenantsPatch, NodePropertySerializablePatch, NoLongerSupportedPatch, NoOpPatch, PermissionDataPatch, PersonUsagePatch, QNamePatch, ResetWCMToGroupBasedPermissionsPatch, RSSTemplatesFolderPatch, SamplePatch, SavedSearchFolderPatch, SavedSearchPermissionPatch, SchemaUpgradeScriptPatch, ScriptsFolderPatch, SitePermissionRefactorPatch, SiteStorePatch, SpacesRootPermissionPatch, SpacesStoreGuestPermissionPatch, SystemDescriptorContentPatch, SystemWorkflowFolderPatch, TopLevelGroupParentChildAssociationTypePatch, UIFacetsAspectRemovalPatch, UpdateGuestPermissionPatch, UserAndPersonTokenisationPatch, VersionHistoryPerformancePatch, WCMFoldersPatch, WCMPostPermissionSnapshotPatch, WebSiteAddModeratedPatch
public interface Patch
A patch is an executable class that makes a change to persisted data.
Auditing information is not maintained by the patch - rather it is solely
responsible for the execution of the processes necessary to apply the patch.
Patches must not be reappliable. It is up to the patch management systems
to ensure that patches are never reapplied.
- Since:
- 1.2
- See Also:
AbstractPatch
getId
java.lang.String getId()
getDescription
java.lang.String getDescription()
getFixesFromSchema
int getFixesFromSchema()
- Returns:
- Returns the smallest schema number that this patch may be applied to
getFixesToSchema
int getFixesToSchema()
- Returns:
- Returns the largest schema number that this patch may be applied to
getTargetSchema
int getTargetSchema()
- Returns:
- Returns the schema number that this patch attempts to bring the repo up to
isForce
boolean isForce()
- Returns:
- Returns true if the patch must forcefully run regardless of any other state
getDependsOn
java.util.List getDependsOn()
- Get patches that this patch depends on
- Returns:
- Returns a list of patches
getAlternatives
java.util.List getAlternatives()
- Get patches that could have done the work already
- Returns:
- Returns a list of patches
applies
boolean applies(int version)
- Check if the patch is applicable to a given schema version.
- Parameters:
version
- a schema version number
- Returns:
- Returns
(fixesFromVersion <= version <= fixesToVersion)
apply
java.lang.String apply()
throws PatchException
- Applies the patch. Typically this will be within the bounds of a new
transaction.
- Returns:
- Returns the patch execution report
- Throws:
PatchException
- if the patch failed to be applied
Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.