001/**
002 * Copyright 2005-2017 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kew.batch;
017
018/**
019 * Service responsible for polling a location for
020 * xml documents to ingest.
021 * Pipeline:<br/>
022 * <ol>
023 *   <li>Acquisition: <code>XmlPollerService</code>, <i>Struts upload action</i></li>
024 *   <li>Ingestion: XmlIngesterService</li>
025 *   <li>Digestion: XmlDigesterService</li>
026 * </ol>
027 * @see org.kuali.rice.kew.batch.XmlIngesterService
028 * @author Kuali Rice Team (rice.collab@kuali.org)
029 */
030public interface XmlPollerService extends Runnable {
031
032        public static final String XML_ROOT_LOC_PROP = "data.xml.root.location";
033        public static final String XML_PENDING_LOC_PROP = "data.xml.pending.location";
034        public static final String XML_COMPLETED_LOC_PROP = "data.xml.completed.location";
035        public static final String XML_PROBLEM_LOC_PROP = "data.xml.problem.location";
036        public static final String XML_POLL_INTERVAL_PROP = "data.xml.pollIntervalSecs";
037        public static final String XML_INIT_DELAY_SECS_PROP = "initialDelaySecs";
038
039    int getPollIntervalSecs();
040    int getInitialDelaySecs();
041
042}