org.mule.config.QueueProfile Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mule-core Show documentation
Mule server and core classes
There is a newer version: 3.9.0
/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */

package org.mule.config;

import org.mule.api.MuleContext;
import org.mule.api.config.MuleProperties;
import org.mule.api.context.MuleContextAware;
import org.mule.api.lifecycle.InitialisationException;
import org.mule.api.store.ListableObjectStore;
import org.mule.api.store.QueueStore;
import org.mule.util.queue.DefaultQueueConfiguration;
import org.mule.util.queue.DelegateQueueManager;
import org.mule.util.queue.QueueConfiguration;
import org.mule.util.queue.QueueManager;

import java.io.Serializable;

/**
 * QueueProfile determines how an internal queue for a service will
 * behave
 */
public class QueueProfile
{
    private int maxOutstandingMessages = 0;
    private QueueStore objectStore;

    public static QueueProfile newInstancePersistingToDefaultMemoryQueueStore(MuleContext muleContext)
    {
        return newInstance(MuleProperties.QUEUE_STORE_DEFAULT_IN_MEMORY_NAME, muleContext);
    }

    public static QueueProfile newInstanceWithPersistentQueueStore(MuleContext muleContext)
    {
        return newInstance(MuleProperties.QUEUE_STORE_DEFAULT_PERSISTENT_NAME, muleContext);
    }

    private static QueueProfile newInstance(String objectStoreKey, MuleContext muleContext)
    {
        QueueStore objectStore = muleContext.getRegistry().lookupObject(objectStoreKey);
        return new QueueProfile(objectStore);
    }

    public QueueProfile(QueueStore objectStore)
    {
        this.objectStore = objectStore;
    }

    // TODO DO: is this ctor required at all? It's not used anywhere in the code base
    public QueueProfile(QueueProfile queueProfile)
    {
        this.maxOutstandingMessages = queueProfile.getMaxOutstandingMessages();
        this.objectStore = queueProfile.objectStore;
    }

    public QueueProfile(int maxOutstandingMessages, QueueStore objectStore)
    {
        this.maxOutstandingMessages = maxOutstandingMessages;
        this.objectStore = objectStore;
    }

    /**
     * This specifies the number of messages that can be queued before it starts
     * blocking.
     * 
     * @return the max number of messages that will be queued
     */
    public int getMaxOutstandingMessages()
    {
        return maxOutstandingMessages;
    }

    /**
     * This specifies the number of messages that can be queued before it starts
     * blocking.
     * 
     * @param maxOutstandingMessages the max number of messages that will be queued
     */
    public void setMaxOutstandingMessages(int maxOutstandingMessages)
    {
        this.maxOutstandingMessages = maxOutstandingMessages;
    }

    public QueueConfiguration configureQueue(MuleContext context, String component, QueueManager queueManager)
        throws InitialisationException
    {
        QueueConfiguration qc = toQueueConfiguration(context);
        queueManager.setQueueConfiguration(component, qc);
        return qc;
    }

    public QueueConfiguration toQueueConfiguration(MuleContext context)
    {
        if (objectStore instanceof MuleContextAware)
        {
            ((MuleContextAware) objectStore).setMuleContext(context);
        }
        if (DelegateQueueManager.isOldModeEnabled())
        {
            return new org.mule.util.queue.objectstore.QueueConfiguration(context, maxOutstandingMessages, objectStore);
        }
        return new DefaultQueueConfiguration(maxOutstandingMessages, objectStore.isPersistent());
    }

    public ListableObjectStore getObjectStore()
    {
        return objectStore;
    }

    public void setQueueStore(QueueStore objectStore)
    {
        this.objectStore = objectStore;
    }

    public void addQueueStore(QueueStore objectStore)
    {
        this.objectStore = objectStore;
    }

    @Override
    public String toString()
    {
        return "QueueProfile{maxOutstandingMessage=" + maxOutstandingMessages + ", storeType="
               + objectStore.getClass() + "}";
    }
}