com.tangosol.coherence.config.builder.SubscriberGroupBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of coherence Show documentation

Oracle Coherence Community Edition

There is a newer version: 24.09

/*
 * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
 *
 * Licensed under the Universal Permissive License v 1.0 as shown at
 * http://oss.oracle.com/licenses/upl.
 */
package com.tangosol.coherence.config.builder;

import com.tangosol.coherence.config.ParameterMacroExpression;

import com.tangosol.config.annotation.Injectable;
import com.tangosol.config.expression.ParameterResolver;

import com.tangosol.net.topic.NamedTopic;
import com.tangosol.net.topic.Subscriber;

/**
 * The {@link SubscriberGroupBuilder} builds a {@link Subscriber} group.
 *
 * @author jf 2016.03.02
 * @since Coherence 14.1.1
 */
public class SubscriberGroupBuilder
    {
    // ----- SubscriberGroupBuilder methods ---------------------------------

    /**
     * Realize a durable {@link Subscriber} for the named group.
     *
     * @param topic     topic to create subscriber for
     * @param resolver  resolve values containing parameter macros within this builder
     *
     * @return {@link Subscriber}
     */
    @SuppressWarnings("unchecked")
    public Subscriber realize(NamedTopic topic, ParameterResolver resolver)
        {
        return topic.createSubscriber(Subscriber.Name.of(getSubscriberGroupName(resolver)));
        }

    /**
     * Set the subscriber group name.
     *
     * @param sName durable subscriber name, possibly containing parameter macro {topic-name}
     */
    @Injectable("name")
    public void setSubscriberGroupName(String sName)
        {
        m_exprGroupName = new ParameterMacroExpression(sName, String.class);
        }

    /**
     * Get the subscriber group name.
     *
     * @param resolver  used to resolve {topic-name} parameter macro if present.
     *
     * @return parameter macro expanded durable subscriber name
     */
    public String getSubscriberGroupName(ParameterResolver resolver)
        {
        return m_exprGroupName.evaluate(resolver);
        }


    // ----- Object methods -------------------------------------------------

    /**
     * {@inheritDoc}
     */
    public String toString()
        {
        return "SubscriberGroupBuilder : groupName=" + m_exprGroupName;
        }

    // ----- data members ---------------------------------------------------

    /**
     * Subscriber group name allowing for parameter macro expansion of {topic-name}.
     */
    private ParameterMacroExpression m_exprGroupName;
    }