01: /**
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: */package org.apache.cxf.workqueue;
19:
20: public interface WorkQueueManager {
21:
22: enum ThreadingModel {
23: SINGLE_THREADED, MULTI_THREADED
24: };
25:
26: /**
27: * Get the manager's work queue.
28: * @return AutomaticWorkQueue
29: */
30: AutomaticWorkQueue getAutomaticWorkQueue();
31:
32: /**
33: * Get the threading model.
34: * @return ThreadingModel - either <code>SINGLE_THREADED</code>
35: * or <code>MULTI_THREADED</code>.
36: */
37: ThreadingModel getThreadingModel();
38:
39: /**
40: * Set the threading model.
41: * @param model either <code>SINGLE_THREADED</code>
42: * or <code>MULTI_THREADED</code>.
43: */
44: void setThreadingModel(ThreadingModel model);
45:
46: /**
47: * Shuts down the manager's work queue. If
48: * <code>processRemainingTasks</code> is true, waits for the work queue to
49: * shutdown before returning.
50: * @param processRemainingTasks - whether or not to wait for completion
51: */
52: void shutdown(boolean processRemainingTasks);
53:
54: /**
55: * Only returns after workqueue has been shutdown.
56: *
57: */
58: void run();
59: }
|