org.apache.jcs.auxiliary.lateral.LateralCacheNoWaitFacade.java Source code

Java tutorial

Introduction

Here is the source code for org.apache.jcs.auxiliary.lateral.LateralCacheNoWaitFacade.java

Source

package org.apache.jcs.auxiliary.lateral;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Set;
import java.util.HashSet;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.jcs.auxiliary.AuxiliaryCache;
import org.apache.jcs.auxiliary.AuxiliaryCacheAttributes;
import org.apache.jcs.auxiliary.lateral.behavior.ILateralCacheAttributes;
import org.apache.jcs.engine.behavior.ICacheElement;
import org.apache.jcs.engine.behavior.ICacheType;
import org.apache.jcs.engine.stats.StatElement;
import org.apache.jcs.engine.stats.Stats;
import org.apache.jcs.engine.stats.behavior.IStatElement;
import org.apache.jcs.engine.stats.behavior.IStats;

/**
 * Used to provide access to multiple services under nowait protection.
 * Composite factory should construct LateralCacheNoWaitFacade to give to the
 * composite cache out of caches it constructs from the varies manager to
 * lateral services. Perhaps the lateralcache factory should be able to do this.
 *
 */
public class LateralCacheNoWaitFacade implements AuxiliaryCache {
    private static final long serialVersionUID = -9047687810358008955L;

    private final static Log log = LogFactory.getLog(LateralCacheNoWaitFacade.class);

    /** The queuing facade to the client. */
    public LateralCacheNoWait[] noWaits;

    private String cacheName;

    private ILateralCacheAttributes lateralCacheAttributes;

    /**
     * Constructs with the given lateral cache, and fires events to any
     * listeners.
     *
     * @param noWaits
     * @param cattr
     */
    public LateralCacheNoWaitFacade(LateralCacheNoWait[] noWaits, ILateralCacheAttributes cattr) {
        if (log.isDebugEnabled()) {
            log.debug("CONSTRUCTING NO WAIT FACADE");
        }
        this.noWaits = noWaits;
        this.cacheName = cattr.getCacheName();
        this.lateralCacheAttributes = cattr;
    }

    /**
     * Adds a no wait to the list if it isn't already in the list.
     * <p>
     * @param noWait
     * @return true if it wasn't alreay contained
     */
    public boolean addNoWait(LateralCacheNoWait noWait) {
        if (noWait == null) {
            return false;
        }

        for (int i = 0; i < noWaits.length; i++) {
            // we know noWait isn't null
            if (noWait.equals(noWaits[i])) {
                if (log.isDebugEnabled()) {
                    log.debug("No Wait already contained, [" + noWait + "]");
                }
                return false;
            }
        }

        LateralCacheNoWait[] newArray = new LateralCacheNoWait[noWaits.length + 1];

        System.arraycopy(noWaits, 0, newArray, 0, noWaits.length);

        // set the last position to the new noWait
        newArray[noWaits.length] = noWait;

        noWaits = newArray;

        return true;

    }

    /*
     * (non-Javadoc)
     *
     * @see org.apache.jcs.engine.behavior.ICache#update(org.apache.jcs.engine.behavior.ICacheElement)
     */
    public void update(ICacheElement ce) throws IOException {
        if (log.isDebugEnabled()) {
            log.debug("updating through lateral cache facade, noWaits.length = " + noWaits.length);
        }
        try {
            for (int i = 0; i < noWaits.length; i++) {
                noWaits[i].update(ce);
            }
        } catch (Exception ex) {
            log.error(ex);
        }
    }

    /**
     * Synchronously reads from the lateral cache.
     * <p>
     * @param key
     * @return ICacheElement
     */
    public ICacheElement get(Serializable key) {
        for (int i = 0; i < noWaits.length; i++) {
            try {
                Object obj = noWaits[i].get(key);

                if (obj != null) {
                    // TODO: return after first success
                    // could do this simultaneously
                    // serious blocking risk here
                    return (ICacheElement) obj;
                }
            } catch (Exception ex) {
                log.error("Failed to get", ex);
            }
            return null;
        }
        return null;
    }

    /*
     * (non-Javadoc)
     *
     * @see org.apache.jcs.auxiliary.AuxiliaryCache#getGroupKeys(java.lang.String)
     */
    public Set getGroupKeys(String group) {
        HashSet allKeys = new HashSet();
        for (int i = 0; i < noWaits.length; i++) {
            AuxiliaryCache aux = noWaits[i];
            if (aux != null) {
                try {
                    allKeys.addAll(aux.getGroupKeys(group));
                } catch (IOException e) {
                    // ignore
                }
            }
        }
        return allKeys;
    }

    /**
     * Adds a remove request to the lateral cache.
     * <p>
     * @param key
     * @return always false.
     */
    public boolean remove(Serializable key) {
        try {
            for (int i = 0; i < noWaits.length; i++) {
                noWaits[i].remove(key);
            }
        } catch (Exception ex) {
            log.error(ex);
        }
        return false;
    }

    /**
     * Adds a removeAll request to the lateral cache.
     */
    public void removeAll() {
        try {
            for (int i = 0; i < noWaits.length; i++) {
                noWaits[i].removeAll();
            }
        } catch (Exception ex) {
            log.error(ex);
        }
    }

    /** Adds a dispose request to the lateral cache. */
    public void dispose() {
        try {
            for (int i = 0; i < noWaits.length; i++) {
                noWaits[i].dispose();
            }
        } catch (Exception ex) {
            log.error(ex);
        }
    }

    /**
     * No lateral invokation.
     *
     * @return The size value
     */
    public int getSize() {
        return 0;
        //cache.getSize();
    }

    /**
     * Gets the cacheType attribute of the LateralCacheNoWaitFacade object
     *
     * @return The cacheType value
     */
    public int getCacheType() {
        return ICacheType.LATERAL_CACHE;
    }

    /**
     * Gets the cacheName attribute of the LateralCacheNoWaitFacade object
     *
     * @return The cacheName value
     */
    public String getCacheName() {
        return "";
        //cache.getCacheName();
    }

    // need to do something with this
    /**
     * Gets the status attribute of the LateralCacheNoWaitFacade object
     *
     * @return The status value
     */
    public int getStatus() {
        return 0;
        //q.isAlive() ? cache.getStatus() : cache.STATUS_ERROR;
    }

    /**
     * @return Returns the AuxiliaryCacheAttributes.
     */
    public AuxiliaryCacheAttributes getAuxiliaryCacheAttributes() {
        return this.lateralCacheAttributes;
    }

    /*
     * (non-Javadoc)
     *
     * @see java.lang.Object#toString()
     */
    public String toString() {
        return "LateralCacheNoWaitFacade: " + cacheName;
    }

    /**
     * getStats
     *
     * @return String
     */
    public String getStats() {
        return getStatistics().toString();
    }

    /*
     * (non-Javadoc)
     *
     * @see org.apache.jcs.auxiliary.AuxiliaryCache#getStatistics()
     */
    public IStats getStatistics() {
        IStats stats = new Stats();
        stats.setTypeName("Lateral Cache No Wait Facade");

        ArrayList elems = new ArrayList();

        IStatElement se = null;

        if (noWaits != null) {
            se = new StatElement();
            se.setName("Number of No Waits");
            se.setData("" + noWaits.length);
            elems.add(se);

            for (int i = 0; i < noWaits.length; i++) {
                if (noWaits[i] != null) {
                    // get the stats from the super too
                    // get as array, convert to list, add list to our outer list
                    IStats sStats = noWaits[i].getStatistics();
                    IStatElement[] sSEs = sStats.getStatElements();
                    List sL = Arrays.asList(sSEs);
                    elems.addAll(sL);
                }
            }

        }

        // get an array and put them in the Stats object
        IStatElement[] ses = (IStatElement[]) elems.toArray(new StatElement[0]);
        stats.setStatElements(ses);

        return stats;
    }
}