io.rocketbase.commons.security.CustomAuthoritiesProvider Maven / Gradle / Ivy

Go to download

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

There is a newer version: 4.4.1

package io.rocketbase.commons.security;

import io.rocketbase.commons.model.AppUserToken;
import org.springframework.security.core.GrantedAuthority;

import javax.servlet.http.HttpServletRequest;
import java.util.Collection;

/**
 * provide extra authorities apart from the general user-roles stored in db
 */
public interface CustomAuthoritiesProvider {

    /**
     * will get injected in case of jwt-token creation

     * that means they are also present in case of SecurityContext

     * this should be considered for nearly static authorities that don't switch during a session
     *
     * @return a not nullable list of extra authorities / could also be an empty list
     */
    Collection getExtraTokenAuthorities(AppUserToken user);

    /**
     * will get injected in case of SecurityContext initialization

     * you will find it in the security filter {@link io.rocketbase.commons.filter.JwtAuthenticationTokenFilter}

     * this should be considered for nearly dynamic authorities

     * keep in mind that also the extra token authorities will be present already
     *
     * @return a not nullable list of extra authorities / could also be an empty list
     */
    Collection getExtraSecurityContextAuthorities(AppUserToken user, HttpServletRequest request);
}