View Javadoc

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