org.apache.qpid.jms.policy.JmsDefaultMessageIDPolicy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qpid-jms-client Show documentation
The core JMS Client implementation
There is a newer version: 2.6.1
/*
 * 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.qpid.jms.policy;

import org.apache.qpid.jms.JmsDestination;
import org.apache.qpid.jms.JmsSession;
import org.apache.qpid.jms.message.JmsMessageIDBuilder;

/**
 * The default MessageID policy used for all MessageProducers created from the
 * client's connection factory.
 */
public class JmsDefaultMessageIDPolicy implements JmsMessageIDPolicy {

    /**
     * A global builder instance to use instead of allocating one on each builder get.
     */
    private volatile JmsMessageIDBuilder messageIDBuilder = null;

    /**
     * The message id builder type that should be used when creating a new builder instance.
     */
    private JmsMessageIDBuilder.BUILTIN messageIDBuilderType = JmsMessageIDBuilder.BUILTIN.DEFAULT;

    /**
     * Initialize default Message ID builder policy
     */
    public JmsDefaultMessageIDPolicy() {
    }

    /**
     * Creates a new JmsDefaultMessageIDPolicy instance copied from the source policy.
     *
     * @param source
     *      The policy instance to copy values from.
     */
    public JmsDefaultMessageIDPolicy(JmsDefaultMessageIDPolicy source) {
        this.messageIDBuilder = source.messageIDBuilder;
        this.messageIDBuilderType = source.messageIDBuilderType;
    }

    @Override
    public JmsDefaultMessageIDPolicy copy() {
        return new JmsDefaultMessageIDPolicy(this);
    }

    @Override
    public JmsMessageIDBuilder getMessageIDBuilder(JmsSession session, JmsDestination destination) {
        return getMessageIDBuilder();
    }

    /**
     * Sets the type of the Message IDs used to populate the outgoing Messages
     *
     * @param type
     *      The name of the Message type to use when sending a message.
     */
    public void setMessageIDType(String type) {
        this.messageIDBuilderType = JmsMessageIDBuilder.BUILTIN.validate(type);
    }

    /**
     * @return the type name of the configured JmsMessageIDBuilder.
     */
    public String getMessageIDType() {
        return getMessageIDBuilder().toString();
    }

    public JmsMessageIDBuilder getMessageIDBuilder() {
        JmsMessageIDBuilder builder = this.messageIDBuilder;

        // If the user has not overridden the create a builder on each call behavior
        // by passing in a single global instance than use the current set type to
        // create a new builder each time this method is called.
        if (builder == null) {
            builder = messageIDBuilderType.createBuilder();
        }
        return builder;
    }

    public void setMessageIDBuilder(JmsMessageIDBuilder messageIDBuilder) {
        this.messageIDBuilder = messageIDBuilder;
    }
}