01: /*
02: * Copyright 2005-2006 The Kuali Foundation.
03: *
04: *
05: * Licensed under the Educational Community License, Version 1.0 (the "License");
06: * you may not use this file except in compliance with the License.
07: * You may obtain a copy of the License at
08: *
09: * http://www.opensource.org/licenses/ecl1.php
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package edu.iu.uis.eden.batch;
18:
19: import java.io.IOException;
20:
21: import edu.iu.uis.eden.XmlLoader;
22: import edu.iu.uis.eden.user.WorkflowUser;
23:
24: /**
25: * A service which is responsible for digesting (by delegating to other target services)
26: * an xml document loaded at runtime. It exists so that we can apply Spring's automagical
27: * transactioning. Ordering of invocations with respect to service dependencies is the
28: * caller's responsibility.
29: * Pipeline:<br/>
30: * <ol>
31: * <li>Acquisition: <code>XmlPollerService</code>, <i>Struts upload action</i></li>
32: * <li>Ingestion: XmlIngesterService</li>
33: * <li>Digestion: XmlDigesterService</li>
34: * </ol>
35: * @see edu.iu.uis.eden.batch.XmlIngesterService
36: * @author Aaron Hamid (arh14 at cornell dot edu)
37: */
38: public interface XmlDigesterService {
39:
40: /**
41: * Digests an XmlDoc. Workflow User is passed to XmlLoader and the content is routing in a document
42: * as that user if the loader supports it.
43: *
44: * @param xmlLoader
45: * @param xmlDoc
46: * @param user
47: * @throws IOException
48: */
49: public void digest(XmlLoader xmlLoader,
50: XmlDocCollection xmlDocCollection, WorkflowUser user)
51: throws IOException;
52: }
|