View Javadoc

1   /*
2    * Copyright 2005-2008 The Kuali Foundation
3    *
4    *
5    * Licensed under the Educational Community License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    *
9    * http://www.opensource.org/licenses/ecl2.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 org.kuali.rice.kew.batch;
18  
19  /**
20   * Service responsible for polling a location for
21   * xml documents to ingest.
22   * Pipeline:<br/>
23   * <ol>
24   *   <li>Acquisition: <code>XmlPollerService</code>, <i>Struts upload action</i></li>
25   *   <li>Ingestion: XmlIngesterService</li>
26   *   <li>Digestion: XmlDigesterService</li>
27   * </ol>
28   * @see org.kuali.rice.kew.batch.XmlIngesterService
29   * @author Kuali Rice Team (rice.collab@kuali.org)
30   */
31  public interface XmlPollerService extends Runnable {
32  
33  	public static final String XML_ROOT_LOC_PROP = "data.xml.root.location";
34  	public static final String XML_PENDING_LOC_PROP = "data.xml.pending.location";
35  	public static final String XML_COMPLETED_LOC_PROP = "data.xml.completed.location";
36  	public static final String XML_PROBLEM_LOC_PROP = "data.xml.problem.location";
37  	public static final String XML_POLL_INTERVAL_PROP = "data.xml.pollIntervalSecs";
38  	public static final String XML_INIT_DELAY_SECS_PROP = "initialDelaySecs";
39  
40      int getPollIntervalSecs();
41      int getInitialDelaySecs();
42  
43  }