1 package org.apache.jcs.auxiliary;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 import java.io.Serializable;
23
24 /***
25 * This is a nominal interface that auxiliary cache attributes should
26 * implement. This allows the auxiliary mangers to share a common interface.
27 *
28 */
29 public interface AuxiliaryCacheAttributes
30 extends Cloneable, Serializable
31 {
32
33 /***
34 * Does not use a thread pool.
35 */
36 public static final String SINGLE_QUEUE_TYPE = "SINGLE";
37
38 /***
39 * Uses a thread pool
40 */
41 public static final String POOLED_QUEUE_TYPE = "POOLED";
42
43 /***
44 * Sets the name of the cache, referenced by the appropriate manager.
45 *
46 * @param s
47 * The new cacheName value
48 */
49 public void setCacheName( String s );
50
51 /***
52 * Gets the cacheName attribute of the AuxiliaryCacheAttributes object
53 *
54 * @return The cacheName value
55 */
56 public String getCacheName();
57
58 /***
59 * Name known by by configurator
60 *
61 * @param s
62 * The new name value
63 */
64 public void setName( String s );
65
66 /***
67 * Gets the name attribute of the AuxiliaryCacheAttributes object
68 *
69 * @return The name value
70 */
71 public String getName();
72
73 /***
74 * SINGLE is the default. If you choose POOLED, the value of
75 * EventQueuePoolName will be used
76 *
77 * @param s
78 * SINGLE or POOLED
79 * @return
80 */
81 public void setEventQueueType( String s );
82
83 /***
84 *
85 * @return SINGLE or POOLED
86 */
87 public String getEventQueueType();
88
89 /***
90 * Returns the value used by the factory.
91 *
92 * @return
93 */
94 public int getEventQueueTypeFactoryCode();
95
96 /***
97 * If you choose a POOLED event queue type, the value of EventQueuePoolName
98 * will be used. This is ignored if the pool type is SINGLE
99 *
100 * @param s
101 * SINGLE or POOLED
102 * @return
103 */
104 public void setEventQueuePoolName( String s );
105
106 /***
107 * Sets the pool name to use. If a pool is not found by this name, the
108 * thread pool manager will return a default configuration.
109 *
110 * @return name of thread pool to use for this auxiliary
111 */
112 public String getEventQueuePoolName();
113
114 /***
115 * Description of the Method
116 *
117 * @return
118 */
119 public AuxiliaryCacheAttributes copy();
120
121 }