activemq-broker/src/main/java/org/apache/activemq/plugin/ForcePersistencyModeBrokerPlugin.java

/**
 * 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.
 */
package org.apache.activemq.plugin;

import org.apache.activemq.broker.Broker;
import org.apache.activemq.broker.BrokerPlugin;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * A Plugin which allows to force every incoming message to be PERSISTENT or
 * NON-PERSISTENT.
 *
 * Useful, if you have set the broker usage policy to process ONLY persistent or
 * ONLY non-persistent messages.
 *
 * @org.apache.xbean.XBean element="forcePersistencyModeBrokerPlugin"
 */
public class ForcePersistencyModeBrokerPlugin implements BrokerPlugin {
    private static Logger LOG = LoggerFactory.getLogger(ForcePersistencyModeBrokerPlugin.class);
    private boolean persistenceFlag = false;

    /**
     * Constructor
     */
    public ForcePersistencyModeBrokerPlugin() {}

    /**
     * @param broker
     *
     * @return the Broker
     *
     * @throws Exception
     *
     * @see org.apache.activemq.broker.BrokerPlugin#installPlugin(org.apache.activemq.broker.Broker)
     */
    @Override
    public Broker installPlugin(Broker broker) throws Exception {
        ForcePersistencyModeBroker pB = new ForcePersistencyModeBroker(broker);
        pB.setPersistenceFlag(isPersistenceForced());
        LOG.info("Installing ForcePersistencyModeBroker plugin: persistency enforced={}", pB.isPersistent());
        return pB;
    }

    /**
     * Sets the persistence mode.
     *
     * @param persistenceFlag
     */
    public void setPersistenceFlag(final boolean persistenceFlag) {
        this.persistenceFlag = persistenceFlag;
    }

    /**
     * @return the mode the (activated) plugin will set the message delivery
     *         mode
     */
    public final boolean isPersistenceForced() {
        return persistenceFlag;
    }
}