ServerSettings.java

/*************************************************************************
 * 
 * ADOBE CONFIDENTIAL __________________
 * 
 * [2002] - [2007] Adobe Systems Incorporated All Rights Reserved.
 * 
 * NOTICE: All information contained herein is, and remains the property of Adobe Systems Incorporated and its suppliers, if any. The intellectual and technical concepts contained herein are
 * proprietary to Adobe Systems Incorporated and its suppliers and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law. Dissemination of
 * this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Adobe Systems Incorporated.
 **************************************************************************/
package flex.messaging.config;

import flex.messaging.services.messaging.MessagingConstants;

/**
 * Server settings for a message destination.
 */
public class ServerSettings
{
    // Errors
    private static final int INVALID_CLUSTER_MESSAGE_ROUTING = 11121;

    private boolean allowSubtopics;
    private boolean broadcastRoutingMode;
    private int maxCacheSize;
    private long messageTTL = -1; // We need to keep track of uninitialized value
    private boolean isDurable;
    private String subtopicSeparator;

    /**
     * Creates a default <code>ServerSettings</code> instance.
     */
    public ServerSettings()
    {
        broadcastRoutingMode = false;
        isDurable = false;
        maxCacheSize = MessagingConstants.DEFAULT_MAX_CACHE_SIZE;
        subtopicSeparator = MessagingConstants.DEFAULT_SUBTOPIC_SEPARATOR;
    }

    /**
     * Returns <code>allow-subtopics</code> property.
     * 
     * @return a boolean specifying whether or not the server has the <code>allow-subtopics</code> property.
     */
    public boolean getAllowSubtopics()
    {
        return allowSubtopics;
    }

    /**
     * Sets <code>allow-subtopics</code> property.
     * 
     * @param value
     *            The value for <code>allow-subtopics</code> property.
     */
    public void setAllowSubtopics(boolean value)
    {
        allowSubtopics = value;
    }

    /**
     * Returns <code>cluster-message-routing</code> property.
     * 
     * @return a boolean specifying whether or not the server has the <code>cluster-message-routing</code> property.
     */
    public boolean isBroadcastRoutingMode()
    {
        return broadcastRoutingMode;
    }

    /**
     * Sets the <code>cluster-message-routing</code> property.
     * 
     * @param routingMode
     *            <code>server-to-server</code>(default) or <code>broadcast</code>.
     */
    public void setBroadcastRoutingMode(String routingMode)
    {
        if (routingMode.equalsIgnoreCase("broadcast"))
            broadcastRoutingMode = true;
        else if (routingMode.equalsIgnoreCase("server-to-server"))
            broadcastRoutingMode = false;
        else
        {
            ConfigurationException ce = new ConfigurationException();
            ce.setMessage(INVALID_CLUSTER_MESSAGE_ROUTING, new Object[] { routingMode });
            throw ce;
        }
    }

    /**
     * Returns the max number of messages to maintain in memory cache.
     * 
     * @return the max number of messages to maintain in memory cache.
     */
    public int getMaxCacheSize()
    {
        return maxCacheSize;
    }

    /**
     * Sets the max number of messages to maintain in memory cache. Default value is zero.
     * 
     * @param size
     *            The value for <code>max-cache-size</code> property.
     */
    public void setMaxCacheSize(int size)
    {
        maxCacheSize = size;
    }

    /**
     * Returns the <code>message-time-to-live</code> property.
     * 
     * @return the <code>message-time-to-live</code> property.
     */
    public long getMessageTTL()
    {
        return messageTTL;
    }

    /**
     * Sets the <code>message-time-to-live</code> property. Default value is -1.
     * 
     * @param ttl
     *            The value for <code>message-time-to-live</code> property.
     */
    public void setMessageTTL(long ttl)
    {
        messageTTL = ttl;
    }

    /**
     * Returns whether destination is durable.
     * 
     * @return <code>true</code> if destination is durable; otherwise <code>false</code>.
     */
    public boolean isDurable()
    {
        return isDurable;
    }

    /**
     * Sets whether destination is durable. Default value is <code>false</code>.
     * 
     * @param durable
     *            The value for <code>durable</code> property.
     */
    public void setDurable(boolean durable)
    {
        isDurable = durable;
    }

    /**
     * Returns the <code>subtopic-separator</code> property.
     * 
     * @return the <code>subtopic-separator</code> property.
     */
    public String getSubtopicSeparator()
    {
        return subtopicSeparator;
    }

    /**
     * Sets the <code>subtopic-separator</code> property. Optional; the default value is period.
     * 
     * @param value
     *            The value for <code>subtopic-separator</code> property.
     */
    public void setSubtopicSeparator(String value)
    {
        subtopicSeparator = value;
    }
}