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.util.Collection;
20: import java.util.List;
21:
22: import edu.iu.uis.eden.user.WorkflowUser;
23:
24: /**
25: * A service which is responsible for iterating through
26: * a list of xml documents or collections of xml documents
27: * and ingesting them into the workflow engine.
28: * Pipeline:<br/>
29: * <ol>
30: * <li>Acquisition: <code>XmlPollerService</code>, <i>Struts upload action</i></li>
31: * <li>Ingestion: XmlIngesterService</li>
32: * <li>Digestion: XmlDigesterService</li>
33: * </ol>
34: * @see edu.iu.uis.eden.batch.XmlDigesterService
35: * @author Aaron Hamid (arh14 at cornell dot edu)
36: */
37: public interface XmlIngesterService {
38: /**
39: * Ingest a list of xml doc collections
40: * @param xmlDocCollections the list of {@link XmlDocCollection}s
41: * @return failed xml doc collections
42: */
43: Collection ingest(List<XmlDocCollection> xmlDocCollections)
44: throws Exception;
45:
46: /**
47: * Ingest a list of xml doc collections, but it routing is supported by any of the services ultimately being called
48: * route the xml data with user being the initiator of any documents created.
49: * @param xmlDocCollections
50: * @param user
51: * @return failed xml doc collections
52: */
53: Collection ingest(List<XmlDocCollection> xmlDocCollections,
54: WorkflowUser user) throws Exception;
55: }
|