io.ballerina.messaging.broker.auth.authorization.UserStore Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of broker-auth Show documentation

There is a newer version: 0.970.5

/*
 * Copyright (c) 2018, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 * WSO2 Inc. 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 io.ballerina.messaging.broker.auth.authorization;

import io.ballerina.messaging.broker.auth.AuthException;
import io.ballerina.messaging.broker.auth.authentication.AuthResult;
import io.ballerina.messaging.broker.common.StartupContext;

import java.util.Map;
import java.util.Set;

/**
 * Interface represents user store for broker users which provide authorization groups..
 */
public interface UserStore {

    /**
     * Initialize authorization strategy based on given auth configuration, user store manager and data source.
     *
     * @param startupContext the startup context provides registered services for authorizer
     * @param properties user store properties
     */
    void initialize(StartupContext startupContext, Map properties) throws Exception;

    /**
     * Get set of user Groups for the user
     *
     * @param userId user id
     * @return set of user groups
     * @throws AuthException throws if error occurs while authorizing user
     */
    Set getUserGroupsList(String userId) throws AuthException;

    /**
     * Authenticate given user with credentials.
     *
     * @param username    userName
     * @param credentials credentials
     * @return Authentication result
     * @throws AuthException Exception throws when authentication failed.
     */
    AuthResult authenticate(String username, char... credentials) throws AuthException;

    /**
     * Verify given username against underlying user store
     *
     * @param username username to verify
     * @return true or false based on the verification
     */
    boolean isUserExists(String username);
}