001package org.apache.commons.jcs3.auxiliary.remote.behavior;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.commons.jcs3.engine.behavior.ICacheServiceNonLocal;
023
024
025/**
026 * This holds constants that are used by the remote cache.
027 */
028public interface IRemoteCacheConstants
029{
030    /** Mapping to props file value */
031    String REMOTE_CACHE_SERVICE_VAL = ICacheServiceNonLocal.class.getName();
032
033    /** The prefix for cache server config. */
034    String CACHE_SERVER_PREFIX = "jcs.remotecache";
035
036    /**
037     * I'm trying to migrate everything to use this prefix. All those below will be replaced. Any of
038     * the RemoteCacheServerAttributes can be configured this way.
039     */
040    String CACHE_SERVER_ATTRIBUTES_PROPERTY_PREFIX = CACHE_SERVER_PREFIX + ".serverattributes";
041
042    /**
043     * This is the name of the class that will be used for an object specific socket factory.
044     */
045    String CUSTOM_RMI_SOCKET_FACTORY_PROPERTY_PREFIX = CACHE_SERVER_PREFIX + ".customrmisocketfactory";
046
047    /** Property prefix, should be jcs.remote but this would break existing config. */
048    String PROPERTY_PREFIX = "remote";
049
050    /**
051     * Mapping to props file value
052     * @deprecated Use CACHE_SERVER_ATTRIBUTES_PROPERTY_PREFIX + ".rmiSocketFactoryTimeoutMillis"
053     */
054    @Deprecated
055    String SOCKET_TIMEOUT_MILLIS = PROPERTY_PREFIX + ".cache.rmiSocketFactoryTimeoutMillis";
056
057    /** Mapping to props file value */
058    String REMOTE_CACHE_SERVICE_NAME = PROPERTY_PREFIX + ".cache.service.name";
059
060    /** Mapping to props file value */
061    String TOMCAT_XML = PROPERTY_PREFIX + ".tomcat.xml";
062
063    /** Mapping to props file value */
064    String TOMCAT_ON = PROPERTY_PREFIX + ".tomcat.on";
065
066    /**
067     * Mapping to props file value
068     * @deprecated Use CACHE_SERVER_ATTRIBUTES_PROPERTY_PREFIX + ".servicePort"
069     */
070    @Deprecated
071    String REMOTE_CACHE_SERVICE_PORT = PROPERTY_PREFIX + ".cache.service.port";
072
073    /**
074     * Mapping to props file value
075     * @deprecated Use CACHE_SERVER_ATTRIBUTES_PROPERTY_PREFIX + ".localClusterConsistency"
076     */
077    @Deprecated
078    String REMOTE_LOCAL_CLUSTER_CONSISTENCY = PROPERTY_PREFIX + ".cluster.LocalClusterConsistency";
079
080    /**
081     * Mapping to props file value
082     * @deprecated Use CACHE_SERVER_ATTRIBUTES_PROPERTY_PREFIX + ".allowClusterGet"
083     */
084    @Deprecated
085    String REMOTE_ALLOW_CLUSTER_GET = PROPERTY_PREFIX + ".cluster.AllowClusterGet";
086}