com.hivemq.extension.sdk.api.services.builder.Builders Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hivemq-extension-sdk Show documentation
SDK for the development of HiveMQ extensions
There is a newer version: 4.35.0
/*
 * Copyright 2018-present HiveMQ GmbH
 *
 * Licensed 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 com.hivemq.extension.sdk.api.services.builder;

import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.annotations.Nullable;
import com.hivemq.extension.sdk.api.auth.parameter.TopicPermission;
import com.hivemq.extension.sdk.api.packets.connect.WillPublishPacket;
import com.hivemq.extension.sdk.api.services.publish.Publish;
import com.hivemq.extension.sdk.api.services.publish.RetainedPublish;
import com.hivemq.extension.sdk.api.services.subscription.TopicSubscription;

import java.util.Map;
import java.util.function.Supplier;

/**
 * This class can be used to create builders for the following objects:
 *
 * 
 *   {@link RetainedPublish}
 *   
{@link Publish}
 *   
{@link TopicPermission}
 *   
{@link TopicSubscription}
 *   
{@link WillPublishPacket}
 * 
 *
 * @author Christoph Schäbel
 * @author Florian Limpöck
 * @since 4.0.0, CE 2019.1
 */
public class Builders {

    private static final String NO_ACCESS_MESSAGE =
            "Static class Builders cannot be called from a thread \"%s\" which" +
                    " does not have a HiveMQ extension classloader as its context classloader.";

    //this map is filled by HiveMQ with implementations for all builders
    @SuppressWarnings("MismatchedQueryAndUpdateOfCollection")
    private static @Nullable Map> builders;

    /**
     * @return A builder for a {@link RetainedPublish}.
     * @since 4.0.0, CE 2019.1
     */
    public static @NotNull RetainedPublishBuilder retainedPublish() {
        return getClassSupplier(RetainedPublishBuilder.class).get();
    }

    /**
     * @return A builder for a {@link Publish}.
     * @since 4.0.0, CE 2019.1
     */
    public static @NotNull PublishBuilder publish() {
        return getClassSupplier(PublishBuilder.class).get();
    }

    /**
     * @return A builder for a {@link TopicPermission}.
     * @since 4.0.0, CE 2019.1
     */
    public static @NotNull TopicPermissionBuilder topicPermission() {
        return getClassSupplier(TopicPermissionBuilder.class).get();
    }

    /**
     * @return A builder for a {@link TopicSubscription}.
     * @since 4.0.0, CE 2019.1
     */
    public static @NotNull TopicSubscriptionBuilder topicSubscription() {
        return getClassSupplier(TopicSubscriptionBuilder.class).get();
    }

    /**
     * @return A builder for a {@link WillPublishPacket}.
     * @since 4.0.0, CE 2019.1
     */
    public static @NotNull WillPublishBuilder willPublish() {
        return getClassSupplier(WillPublishBuilder.class).get();
    }

    private static  @NotNull Supplier getClassSupplier(final @NotNull Class clazz) {

        if (builders == null) {
            throw new RuntimeException(String.format(NO_ACCESS_MESSAGE, Thread.currentThread().getName()));
        }

        final Supplier