com.hivemq.spi.callback.security.OnAuthorizationCallback Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hivemq-spi Show documentation

The Service Provider Interfaces for developing HiveMQ plugins.

There is a newer version: 3.4.4

/*
 * Copyright 2014 dc-square 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.spi.callback.security;

import com.hivemq.spi.callback.SynchronousCallback;
import com.hivemq.spi.callback.security.authorization.AuthorizationBehaviour;
import com.hivemq.spi.security.ClientData;
import com.hivemq.spi.topic.MqttTopicPermission;

import java.util.List;

/**
 * This callback returns a list of {@link MqttTopicPermission}s.
 * 
 * When more OnAuthorizationCallbacks are added only one must return
 * a permission, which matches the required permission to successfully
 * authorize the client action.
 * 

 * It is highly recommended to use proper caching as this callback is
 * called every time HiveMQ asks for the client permissions.
 *
 * @author Christian Goetz
 * @author Christoph Schäbel
 * @since 1.4
 */
public interface OnAuthorizationCallback extends SynchronousCallback {

    /**
     * Returns a list of {@link MqttTopicPermission}s for this client.
     * 
     * Make sure you use proper caching of the returned values as this method will be called very often
     *
     * @param clientData information about the client
     * @return a list of {@link MqttTopicPermission}s for the given client
     */
    List getPermissionsForClient(ClientData clientData);

    /**
     * Declares the default behaviour to use if none of the {@link MqttTopicPermission}s returned by getPermissionForClient matches an activity.
     * The default behaviour should be {@link AuthorizationBehaviour}.NEXT in most cases.
     *
     * @return the default behaviour to use if none of the {@link MqttTopicPermission}s matches an activity.
     */
    AuthorizationBehaviour getDefaultBehaviour();

}