View Javadoc
1   package org.apache.commons.jcs3.auxiliary.remote.behavior;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.commons.jcs3.engine.behavior.ICacheServiceNonLocal;
23  
24  
25  /**
26   * This holds constants that are used by the remote cache.
27   */
28  public interface IRemoteCacheConstants
29  {
30      /** Mapping to props file value */
31      String REMOTE_CACHE_SERVICE_VAL = ICacheServiceNonLocal.class.getName();
32  
33      /** The prefix for cache server config. */
34      String CACHE_SERVER_PREFIX = "jcs.remotecache";
35  
36      /**
37       * I'm trying to migrate everything to use this prefix. All those below will be replaced. Any of
38       * the RemoteCacheServerAttributes can be configured this way.
39       */
40      String CACHE_SERVER_ATTRIBUTES_PROPERTY_PREFIX = CACHE_SERVER_PREFIX + ".serverattributes";
41  
42      /**
43       * This is the name of the class that will be used for an object specific socket factory.
44       */
45      String CUSTOM_RMI_SOCKET_FACTORY_PROPERTY_PREFIX = CACHE_SERVER_PREFIX + ".customrmisocketfactory";
46  
47      /** Property prefix, should be jcs.remote but this would break existing config. */
48      String PROPERTY_PREFIX = "remote";
49  
50      /**
51       * Mapping to props file value
52       * @deprecated Use CACHE_SERVER_ATTRIBUTES_PROPERTY_PREFIX + ".rmiSocketFactoryTimeoutMillis"
53       */
54      @Deprecated
55      String SOCKET_TIMEOUT_MILLIS = PROPERTY_PREFIX + ".cache.rmiSocketFactoryTimeoutMillis";
56  
57      /** Mapping to props file value */
58      String REMOTE_CACHE_SERVICE_NAME = PROPERTY_PREFIX + ".cache.service.name";
59  
60      /** Mapping to props file value */
61      String TOMCAT_XML = PROPERTY_PREFIX + ".tomcat.xml";
62  
63      /** Mapping to props file value */
64      String TOMCAT_ON = PROPERTY_PREFIX + ".tomcat.on";
65  
66      /**
67       * Mapping to props file value
68       * @deprecated Use CACHE_SERVER_ATTRIBUTES_PROPERTY_PREFIX + ".servicePort"
69       */
70      @Deprecated
71      String REMOTE_CACHE_SERVICE_PORT = PROPERTY_PREFIX + ".cache.service.port";
72  
73      /**
74       * Mapping to props file value
75       * @deprecated Use CACHE_SERVER_ATTRIBUTES_PROPERTY_PREFIX + ".localClusterConsistency"
76       */
77      @Deprecated
78      String REMOTE_LOCAL_CLUSTER_CONSISTENCY = PROPERTY_PREFIX + ".cluster.LocalClusterConsistency";
79  
80      /**
81       * Mapping to props file value
82       * @deprecated Use CACHE_SERVER_ATTRIBUTES_PROPERTY_PREFIX + ".allowClusterGet"
83       */
84      @Deprecated
85      String REMOTE_ALLOW_CLUSTER_GET = PROPERTY_PREFIX + ".cluster.AllowClusterGet";
86  }