net.sf.ehcache.distribution.JNDIManualRMICacheManagerPeerProviderFactory.java Source code

Introduction

Here is the source code for net.sf.ehcache.distribution.JNDIManualRMICacheManagerPeerProviderFactory.java

Source

/**
 *  Copyright 2003-2006 Greg Luck
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package net.sf.ehcache.distribution;

import net.sf.ehcache.CacheException;
import net.sf.ehcache.util.PropertyUtil;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import java.util.Properties;
import java.util.StringTokenizer;

/**
 * A factory to build a CacheManagerPeerProvider based on RMI and JNDI.
 *
 * @author Andy McNutt
 * @author Greg Luck
 * @version $Id$
 *
 * Default values where properties are not specified or left empty are:
 * <ol>
 * <li>stashContexts - true
 * <li>stashRemoteCachePeers - true
 * </ol>
 *
 */
public class JNDIManualRMICacheManagerPeerProviderFactory extends RMICacheManagerPeerProviderFactory {

    private static final Log LOG = LogFactory.getLog(JNDIManualRMICacheManagerPeerProviderFactory.class.getName());

    private static final String JNDI_URLS = "jndiUrls";
    private static final String STASH_CONTEXTS = "stashContexts";
    private static final String STASH_REMOTE_CACHE_PEERS = "stashRemoteCachePeers";

    /**
     * peerDiscovery=manual, 
     * jndiUrls=//hostname:port/cacheName //hostname:port/cacheName
     * The jndiUrls are in the format expected by the implementation of your Context.INITIAL_CONTEXT_FACTORY.
     */
    protected CacheManagerPeerProvider createManuallyConfiguredCachePeerProvider(Properties properties) {
        String urls = PropertyUtil.extractAndLogProperty(JNDI_URLS, properties);
        if (urls == null || urls.length() == 0) {
            throw new CacheException(JNDI_URLS + " must be specified when peerDiscovery is manual");
        }

        boolean stashContexts = isStashContexts(properties);
        boolean stashRemoteCachePeers = isStashRemoteCachePeers(properties);

        JNDIManualRMICacheManagerPeerProvider jndiPeerProvider = new JNDIManualRMICacheManagerPeerProvider(
                stashContexts, stashRemoteCachePeers);
        urls = urls.trim();
        StringTokenizer stringTokenizer = new StringTokenizer(urls, PayloadUtil.URL_DELIMITER);
        while (stringTokenizer.hasMoreTokens()) {
            String jndiUrl = stringTokenizer.nextToken();
            jndiUrl = jndiUrl.trim();
            jndiPeerProvider.registerPeer(jndiUrl);
            if (LOG.isDebugEnabled()) {
                LOG.debug("Registering peer " + jndiUrl);
            }
        }
        return jndiPeerProvider;
    }

    private boolean isStashRemoteCachePeers(Properties properties) {
        String stashRemoteCachePeersString = PropertyUtil.extractAndLogProperty(STASH_REMOTE_CACHE_PEERS,
                properties);
        boolean stashRemoteCachePeers;
        if (stashRemoteCachePeersString == null || stashRemoteCachePeersString.length() == 0) {
            stashRemoteCachePeers = true;
        } else {
            stashRemoteCachePeers = Boolean.valueOf(stashRemoteCachePeersString).booleanValue();
        }
        return stashRemoteCachePeers;
    }

    private boolean isStashContexts(Properties properties) {
        String stashContextsString = PropertyUtil.extractAndLogProperty(STASH_CONTEXTS, properties);
        boolean stashContexts;
        if (stashContextsString == null || stashContextsString.length() == 0) {
            stashContexts = true;
        } else {
            stashContexts = Boolean.valueOf(stashContextsString).booleanValue();
        }
        return stashContexts;
    }

}