io.cellery.observability.auth

Interface AuthProvider

All Known Implementing Classes:

CelleryLocalAuthProvider

public interface AuthProvider

Auth Provider interface used for authentication and authorization in Cellery. This can be implemented to override the auth behaviour of Cellery Observability.

Method Summary

Modifier and Type	Method and Description
Permission[]	getAllAllowedPermissions(String accessToken) Get an array of all the permissions allowed for a user.
boolean	isTokenValid(String token, Permission requiredPermission) Validate the token.

Method Detail

isTokenValid

boolean isTokenValid(String token,
                     Permission requiredPermission)
              throws AuthProviderException

Validate the token. Empty string as runtime in the required permission represents an action that is not runtime aware. Empty string as namespace in the required permission represents an action that is not namespace aware.

Parameters:

token - The token of which the validity should be checked

requiredPermission - The permission required by the user

Returns:

True if the token is valid

Throws:

AuthProviderException - if validating the token fails

getAllAllowedPermissions

Permission[] getAllAllowedPermissions(String accessToken)
                               throws AuthProviderException

Get an array of all the permissions allowed for a user. This is called once per each portal load. This should return all the authorized namespaces in all the authorized runtimes. This is used to ensure that the relevant sections are shown to the user.

Parameters:

accessToken - The access token sent for the action

Returns:

The map of authorized runtime namespaces

Throws:

AuthProviderException - if checking the authorized runtime namespaces failed