mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-08 14:51:49 +00:00
8674e2bfc8
125603 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
125484 slanglois: MNT-16155 Update source headers - remove old Copyrights from Java and JSP dource files
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125781 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
107 lines
3.2 KiB
Java
107 lines
3.2 KiB
Java
package org.alfresco.repo.admin.patch;
|
|
|
|
import java.util.List;
|
|
|
|
import org.alfresco.service.cmr.admin.PatchException;
|
|
|
|
/**
|
|
* A patch is an executable class that makes a change to persisted data.
|
|
* <p>
|
|
* Auditing information is not maintained by the patch - rather it is solely
|
|
* responsible for the execution of the processes necessary to apply the patch.
|
|
* <p>
|
|
* Patches must not be reappliable. It is up to the patch management systems
|
|
* to ensure that patches are <b>never reapplied</b>.
|
|
*
|
|
* @see org.alfresco.repo.admin.patch.AbstractPatch
|
|
* @since 1.2
|
|
* @author Derek Hulley
|
|
*/
|
|
public interface Patch
|
|
{
|
|
public String getId();
|
|
|
|
public String getDescription();
|
|
|
|
/**
|
|
* @return Returns the smallest schema number that this patch may be applied to
|
|
*/
|
|
public int getFixesFromSchema();
|
|
|
|
/**
|
|
* @return Returns the largest schema number that this patch may be applied to
|
|
*/
|
|
public int getFixesToSchema();
|
|
|
|
/**
|
|
* @return Returns the schema number that this patch attempts to bring the repo up to
|
|
*/
|
|
public int getTargetSchema();
|
|
|
|
/**
|
|
* @return Returns <tt>true</tt> if the patch must forcefully run regardless of any other state
|
|
*/
|
|
public boolean isForce();
|
|
|
|
/**
|
|
* Get patches that this patch depends on
|
|
*
|
|
* @return Returns a list of patches
|
|
*/
|
|
public List<Patch> getDependsOn();
|
|
|
|
/**
|
|
* Get patches that could have done the work already
|
|
*
|
|
* @return Returns a list of patches
|
|
*/
|
|
public List<Patch> getAlternatives();
|
|
|
|
/**
|
|
* Check if the patch is applicable to a given schema version.
|
|
*
|
|
* @param version a schema version number
|
|
* @return Returns <code>(fixesFromVersion <= version <= fixesToVersion)</code>
|
|
*/
|
|
public boolean applies(int version);
|
|
|
|
/**
|
|
* Does the patch need to be wrapped in a transaction?
|
|
*
|
|
* @return Returns true if the patch needs to be wrapped, false otherwise
|
|
*/
|
|
public boolean requiresTransaction();
|
|
|
|
/**
|
|
* Applies the patch. Typically this will be within the bounds of a new
|
|
* transaction.
|
|
*
|
|
* @return Returns the patch execution report
|
|
* @throws PatchException if the patch failed to be applied
|
|
*/
|
|
public String apply() throws PatchException;
|
|
|
|
/**
|
|
* Apply the patch, regardless of the deferred flag. So if the patch has not
|
|
* run due to it being deferred earlier then this will run it now. Also
|
|
* ignores the "applied" lock. So the patch can be executed many times.
|
|
*
|
|
* @return the patch report
|
|
* @throws PatchException if the patch failed to be applied
|
|
*/
|
|
public String applyAsync() throws PatchException;
|
|
|
|
/**
|
|
* Is this patch just ignored - never considered for application
|
|
* @return boolean
|
|
*/
|
|
public boolean isIgnored();
|
|
|
|
/**
|
|
* Indicates whether the patch must be deferred (not to be executed in bootstrap) or not
|
|
*
|
|
* @return true if the patch must be deferred, false otherwise
|
|
*/
|
|
public boolean isDeferred();
|
|
}
|