org.killbill.billing.security.api

Interface SecurityApi

All Superinterfaces:

KillbillApi

public interface SecurityApi
extends KillbillApi

Method Summary

Methods

Modifier and Type	Method and Description
void	checkCurrentUserPermissions(List<Permission> permissions, Logical logical, TenantContext context) Check the current user has the set of permissions.
Set<Permission>	getCurrentUserPermissions(TenantContext context) Return the set of permissions for the currently logged-in user.
void	login(Object principal, Object credentials) Perform a login attempt.
void	logout() Log out the current user and invalidate and/or remove any associated entities (e.g.

Method Detail

login

void login(Object principal,
         Object credentials)

Perform a login attempt.

Parameters:

principal - account identity (e.g. username)

credentials - account credentials (e.g. password)

logout

void logout()

Log out the current user and invalidate and/or remove any associated entities (e.g. session).

getCurrentUserPermissions

Set<Permission> getCurrentUserPermissions(TenantContext context)

Return the set of permissions for the currently logged-in user.

Parameters:

context - tenant context

Returns:

the set of permissions for the current user

checkCurrentUserPermissions

void checkCurrentUserPermissions(List<Permission> permissions,
                               Logical logical,
                               TenantContext context)
                                 throws SecurityApiException

Check the current user has the set of permissions.

Parameters:

permissions - set of permissions to check

logical - rule to use for multiple permissions

context - tenant context

Throws:

SecurityException

SecurityApiException