01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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.util.List;
20:
21: import org.apache.jetspeed.util.Queue;
22:
23: /**
24: * The Worker Monitor is a thread manager and monitor for async portlet aggregation
25: * and rendering.
26: *
27: * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
28: * @version $Id: $
29: */
30: public interface WorkerMonitor {
31: /**
32: * Start processing the worker monitor
33: *
34: */
35: void start();
36:
37: /**
38: * Stop processing the worker monitor
39: * Finish all jobs
40: *
41: */
42: void stop();
43:
44: /**
45: * Retrieves a snapshot of job count in the waiting (backlogged) queue
46: *
47: * @return snapshot count of waiting jobs
48: */
49: int getQueuedJobsCount();
50:
51: /**
52: * Returns a snapshot count of the available jobs
53: * @return available jobs count
54: */
55: int getAvailableJobsCount();
56:
57: /**
58: * Returns a snapshot count of the jobs currently running
59: *
60: * @return snapshot count of running jobs
61: */
62: int getRunningJobsCount();
63:
64: /**
65: * Start processing a job, assign it to a worker thread.
66: *
67: * @param job
68: */
69: void process(RenderingJob job);
70:
71: /**
72: * Wait for all rendering jobs in the collection to finish successfully or otherwise.
73: * @param renderingJobs the Collection of rendering job objects to wait for.
74: */
75: public void waitForRenderingJobs(List renderingJobs);
76: }
|