org.apache.manifoldcf.crawler.interfaces.IAbortActivity Maven / Gradle / Ivy

Go to download
/* $Id: IAbortActivity.java 988245 2010-08-23 18:39:35Z kwright $ */

/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.manifoldcf.crawler.interfaces;

import org.apache.manifoldcf.core.interfaces.*;
import org.apache.manifoldcf.agents.interfaces.*;

/** This interface abstracts from the activities that handle job aborts.
*/
public interface IAbortActivity
{
  public static final String _rcsid = "@(#)$Id: IAbortActivity.java 988245 2010-08-23 18:39:35Z kwright $";

  /** Check whether current job is still active.
  * This method is provided to allow an individual connector that needs to wait on some long-term condition to give up waiting due to the job
  * itself being aborted.  If the connector should abort, this method will raise a properly-formed ServiceInterruption, which if thrown to the
  * caller, will signal that the current seeding activity remains incomplete and must be retried when the job is resumed.
  */
  public void checkJobStillActive()
    throws ManifoldCFException, ServiceInterruption;

}