org.opensingular.requirement.module.spring.security.SingularRequirementUserDetails Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2016 Singular Studios (a.k.a Atom Tecnologia) - www.opensingular.com
 *
 * 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 org.opensingular.requirement.module.spring.security;


import org.opensingular.form.spring.SingularUserDetails;
import org.opensingular.requirement.module.config.IServerContext;

import java.util.Arrays;
import java.util.List;

public interface SingularRequirementUserDetails extends SingularUserDetails {
    /**
     * Representantion ID.
     * The same as username by default.
     *
     * @return
     */
    default String getApplicantId() {
        return getUsername();
    }

    /**
     * Contexts in which this user can access
     */
    List> getAllowedContexts();

    /**
     *
     */
    List getPermissions();

    /**
     *
     */
    void addPermission(SingularPermission role);

    /**
     *
     */
    default void addPermissions(SingularPermission... roles) {
        addPermissions(Arrays.asList(roles));
    }

    /**
     *
     */
    default void addPermissions(List roles) {
        if (roles != null) {
            for (SingularPermission role : roles) {
                addPermission(role);
            }
        }
    }
}