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.aggregator;
18  
19  import java.security.AccessControlContext;
20  
21  /***
22   * Worker thread processes jobs and notify its WorkerMonitor when completed.
23   * When no work is available, the worker simply sets itself in a waiting mode
24   * pending reactivation by the WorkerMonitor
25   *
26   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
27   * @version $Id: $
28   */
29  public interface Worker 
30  {
31       int getJobCount();
32  
33      /***
34       * Reset the processed job counter
35       */
36       void resetJobCount();
37  
38      /***
39       * Sets the running status of this Worker. If set to false, the Worker will
40       * stop after processing its current job.
41       */
42       void setRunning(boolean status);
43       
44      /***
45       * Sets the moitor of this worker
46       */
47       void setMonitor(WorkerMonitor monitor);
48       
49      /***
50       * Sets the job to execute in security context
51       */
52       void setJob(Runnable job, AccessControlContext context);
53  
54      /***
55       * Sets the job to execute
56       */
57       void setJob(Runnable job);
58  
59      /***
60       * Retrieves the job to execute
61       */
62       Runnable getJob();
63       
64       void start();
65  }