Files
alfresco-community-repo/source/java/org/alfresco/repo/admin/patch/PatchService.java
Raluca Munteanu 86dc6f3402 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.1.N/root@125603 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-20 10:21:07 +00:00

80 lines
2.9 KiB
Java

package org.alfresco.repo.admin.patch;
import java.util.Date;
import java.util.List;
/**
* Manages patches applied against the repository.
* <p>
* Patches are injected into this class and any attempted applications are recorded for later auditing.
*
* @since 1.2
* @author Derek Hulley
*/
public interface PatchService
{
/**
* Registers a patch with the service that executes them.
*
* @param patch
* the patch to register
*/
public void registerPatch(Patch patch);
/**
* Does some up-front validation on the patches, specifically to see if they all apply to the current server version
* and not some future version. This is to prevent tampering with versioning information attached to a license.
*
* @return true if validation is successful. Outputs errors and returns false otherwise.
*/
public boolean validatePatches();
/**
* Apply all outstanding patches that are relevant to the repo. If there is a failure, then the patches that were
* applied will remain so, but the process will not attempt to apply any further patches.
*
* @return Returns true if all outstanding patches were applied, or false if the process was terminated before all
* patches could be applied.
*/
public boolean applyOutstandingPatches();
/**
* Apply the specified patch that is relevant to the repo, regardless of the <b>deferred</b> flag.
*
* @param patch the patch object
* @return true if the specified patch and its dependencies were applied, or
* false if the process was terminated before all patches could be applied.
*/
public boolean applyOutstandingPatch(Patch patch);
/**
* Retrieves all applied patches between two specific times.
*
* @param fromDate
* the start date of the search, or null to get all patches from the start
* @param toDate
* the end date of the search, or null to g
* @return Returns all applied patches (successful or not)
*/
public List<AppliedPatch> getPatches(Date fromDate, Date toDate);
/**
* Retrieve an existing patch
*
* @param id the patch unique ID
* @return Returns the patch instance or <tt>null</tt> if one has not been persisted
*/
public AppliedPatch getPatch(String id);
/**
* Does some up-front validation on the specified patch, specifically to see
* if it applies to the current server version and not some future version.
* This is to prevent tampering with versioning information attached to a
* license.
*
* @param patch the patch object
* @return true if validation is successful. Outputs errors and returns false otherwise.
*/
public boolean validatePatch(Patch patch);
}