net.sf.ehcache.distribution.jms.JMSEventMessage Maven / Gradle / Ivy

Go to download
/**
 *  Copyright 2003-2008 Luck Consulting Pty Ltd
 *
 *  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.jms;

import net.sf.ehcache.Element;
import net.sf.ehcache.distribution.EventMessage;

import java.io.Serializable;


/**
 * A subclass of EventMessage which describes all of the ehcache distributed message types in a way
 * that works for JMS.
 *
 * @author [email protected]
 * @author Greg Luck
 */
public class JMSEventMessage extends EventMessage {

    /**
     * A JMS message property which contains the name of the cache to operate on.
     */
    public static final String CACHE_NAME_PROPERTY = "cacheName";

    /**
     * A JMS message property which contains the mimeType of the message.
     * Applies to the PUT action. If not set the message is interpreted as follows:
     * 
     * ObjectMessage - if it is an net.sf.ehcache.Element, then it is treated as such and stored in the cache. All others
     * are stored in the cache as value of  MimeTypeByteArray. The mimeType is stored as type of application/x-java-serialized-object.
     * When the ObjectMessage is of type net.sf.ehcache.Element, the mimeType is ignored.
     * 
TextMessage - Stored in the cache as value of MimeTypeByteArray. The mimeType is stored as type of text/plain.
     * 
BytesMessage - Stored in the cache as value of MimeTypeByteArray. The mimeType is stored as type of application/octet-stream.
     * 
     * Other message types are not supported.
     * 
     * To send XML use a TextMessage and set the mimeType to application/xml.It will be stored in the cache
     * as a value of MimeTypeByteArray.
     */
    public static final String MIME_TYPE_PROPERTY = "mimeType";

    /**
     * A JMS message property which contains the action to perform on the cache.
     * Available actions are PUT, REMOVE and REMOVE_ALL.
     * If not set no action is performed.
     */
    public static final String ACTION_PROPERTY = "action";

    /**
     * The key in the cache on which to operate on.
     * The REMOVE_ALL action does not require a key.
     * 
     * If an ObjectMessage of type net.sf.ehcache.Element is sent, the key is contained in the element. Any key
     * set as a property is ignored.
     */
    public static final String KEY_PROPERTY = "key";

    private static final long serialVersionUID = 927345728947584L;

    private String cacheName;
    private Serializable loaderArgument;

    /**
     * @param action    one of the types from Action
     * @param key       the key of the Element. May be null for the removeAll message type. For loadAll requests,
     *                  key may actually be an ArrayList of keys.
     * @param element   may be null for removal and invalidation message types
     * @param cacheName the name of the cache in the CacheManager.
     */
    public JMSEventMessage(Action action,
                           Serializable key,
                           Element element,
                           String cacheName,
                           Serializable loaderArgument) {
        super(action.toInt(), key, element);
        setCacheName(cacheName);
        this.loaderArgument = loaderArgument;
    }

    /**
     * Returns the cache name
     *
     * @return the cache name in the CacheManager.
     */
    public String getCacheName() {
        return cacheName;
    }

    /**
     * Sets the cache name.
     *
     * @param cacheName the name of the cache in the CacheManager
     */
    public void setCacheName(String cacheName) {
        this.cacheName = cacheName;
    }

    /**
     * @return the loader argument. May be and is usually null.
     */
    public Serializable getLoaderArgument() {
        return loaderArgument;
    }

    /**
     * @param loaderArgument
     */
    public void setLoaderArgument(Serializable loaderArgument) {
        this.loaderArgument = loaderArgument;
    }

    /**
     * Returns the message as a String
     *
     * @return a String represenation of the message
     */
    @Override
    public String toString() {
        return new StringBuilder().append("JMSEventMessage ( event = ").append(getEvent()).append(", element = ")
                .append(getElement()).append(", cacheName = ").append(cacheName)
                .append(", key = ").append(getSerializableKey())
                .append(", loaderArgument = ").append(loaderArgument).append(" )").toString();
    }

}