View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
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.apache.jetspeed.scheduler;
18  
19  
20  /***
21   * All Scheduled jobs should extend this.  The class that extends
22   * ScheduledJobs should contain the code that you actually want to
23   * execute at a specific time.  The name of this class is what you
24   * register in the JobEntry.
25   *
26   * @author <a href="mailto:mbryson@mindspring.com">Dave Bryson</a>
27   * @version $Id: ScheduledJob.java 516448 2007-03-09 16:25:47Z ate $
28   */
29  public abstract class ScheduledJob
30  {
31      /***
32       * Run the Jobentry from the scheduler queue.
33       *
34       * @param job The job to run.
35       */
36      public abstract void run( JobEntry job )
37          throws Exception;
38  
39      /***
40       * This is a stop gap until the scheduler service
41       * is fully decoupled from modules. Modules
42       * are for the display system.
43       */
44      public void execute(JobEntry job)
45          throws Exception
46      {
47          run(job);
48      }
49  }