01: /*
02: * Copyright 2007 The Kuali Foundation.
03: *
04: * Licensed under the Educational Community License, Version 1.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.opensource.org/licenses/ecl1.php
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.kuali.kfs.batch;
17:
18: import java.util.Calendar;
19:
20: import org.kuali.core.service.AttachmentService;
21: import org.kuali.kfs.KFSConstants;
22:
23: /**
24: * This class is the batch step used to delete pending attachments that have not yet been associated with a document. When
25: * attachments are attached to docs in an "initiated" state, the attachment is not considered to be linked with the doc in the
26: * persistence layer, and so it becomes a "pending" attachment (i.e. pending persistence). When docs are saved (or submitted, etc.),
27: * pending attachments become permanently persisted to the document and are no longer pending. Pending attachments may have become
28: * orphaned from the document (because the doc has not been saved), and so these orphaned attachments must be deleted. This job uses
29: * the file's last modified time to determine which pending attachments should be deleted. If the modified time is older than the
30: * SYSTEM parameter "pendingAssignmentMaxAge", then it will be deleted.
31: *
32: * @see org.kuali.core.service.impl.AttachmentServiceImpl
33: * @see KFSConstants.SystemGroupParameterNames#PURGE_PENDING_ATTACHMENTS_STEP_MAX_AGE
34: */
35: public class PurgePendingAttachmentsStep extends AbstractStep {
36:
37: private AttachmentService attachmentService;
38:
39: /**
40: * Deletes all pending attachments that are older than a configured time (see class description)
41: *
42: * @see org.kuali.kfs.batch.Step#execute()
43: */
44: public boolean execute(String jobName) {
45: Calendar calendar = getDateTimeService().getCurrentCalendar();
46: String maxAgeInSecondsStr = getParameterService()
47: .getParameterValue(
48: getClass(),
49: KFSConstants.SystemGroupParameterNames.PURGE_PENDING_ATTACHMENTS_STEP_MAX_AGE);
50: int maxAgeInSeconds = Integer.parseInt(maxAgeInSecondsStr);
51: calendar.add(Calendar.SECOND, -maxAgeInSeconds);
52: getAttachmentService().deletePendingAttachmentsModifiedBefore(
53: calendar.getTimeInMillis());
54: return true;
55: }
56:
57: /**
58: * Gets the attachmentService attribute.
59: *
60: * @return Returns the attachmentService.
61: */
62: public AttachmentService getAttachmentService() {
63: return attachmentService;
64: }
65:
66: /**
67: * Sets the attachmentService attribute value.
68: *
69: * @param attachmentService The attachmentService to set.
70: */
71: public void setAttachmentService(AttachmentService attachmentService) {
72: this.attachmentService = attachmentService;
73: }
74: }
|