org.killbill.billing.security.api

Interface SecurityApi

All Superinterfaces:

KillbillApi

public interface SecurityApi
extends KillbillApi

Method Summary

Modifier and Type	Method and Description
void	addRoleDefinition(java.lang.String role, java.util.List<java.lang.String> permissions, CallContext context) Add a role definition in the Shiro store (JDBCRealm)
void	addUserRoles(java.lang.String username, java.lang.String clearPassword, java.util.List<java.lang.String> roles, CallContext context) Add a user with roles in the Shiro store (JDBCRealm)
void	checkCurrentUserPermissions(java.util.List<Permission> permissions, Logical logical, TenantContext context) Check the current user has the set of permissions.
java.util.Set<Permission>	getCurrentUserPermissions(TenantContext context) Return the set of permissions for the currently logged-in user.
java.util.List<java.lang.String>	getRoleDefinition(java.lang.String role, TenantContext tenantContext) Retrieves the list of permissions associated to that role in the Shiro store (JDBCRealm)
java.util.List<java.lang.String>	getUserRoles(java.lang.String username, TenantContext tenantContext) Retrieves the roles associated to a user in the Shiro store (JDBCRealm)
void	invalidateUser(java.lang.String username, CallContext context) Invalidate a user
boolean	isSubjectAuthenticated()
void	login(java.lang.Object principal, java.lang.Object credentials) Perform a login attempt.
void	logout() Log out the current user and invalidate and/or remove any associated entities (e.g.
void	updateRoleDefinition(java.lang.String role, java.util.List<java.lang.String> permissions, CallContext context)
void	updateUserPassword(java.lang.String username, java.lang.String clearPassword, CallContext context) Update password for the user
void	updateUserRoles(java.lang.String username, java.util.List<java.lang.String> roles, CallContext context) Update the roles associated with the user (only the specified roles will be in effect)

Method Detail

login

void login(java.lang.Object principal,
           java.lang.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).

isSubjectAuthenticated

boolean isSubjectAuthenticated()

Returns:

true if the subscjet is authenticated

getCurrentUserPermissions

java.util.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(java.util.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:

java.lang.SecurityException

SecurityApiException

addUserRoles

void addUserRoles(java.lang.String username,
                  java.lang.String clearPassword,
                  java.util.List<java.lang.String> roles,
                  CallContext context)
           throws SecurityApiException

Add a user with roles in the Shiro store (JDBCRealm)

Parameters:

username - the username

clearPassword - the password (in clear)

roles - the list of (existing) roles

context - context (does not include tenant nor account info)

Throws:

SecurityApiException

updateUserPassword

void updateUserPassword(java.lang.String username,
                        java.lang.String clearPassword,
                        CallContext context)
                 throws SecurityApiException

Update password for the user

Parameters:

username - the username

clearPassword - the password (in clear)

context - context (does not include tenant nor account info)

Throws:

SecurityApiException

updateUserRoles

void updateUserRoles(java.lang.String username,
                     java.util.List<java.lang.String> roles,
                     CallContext context)
              throws SecurityApiException

Update the roles associated with the user (only the specified roles will be in effect)

Parameters:

username - the username

roles - the new roles

context - context (does not include tenant nor account info)

Throws:

SecurityApiException

invalidateUser

void invalidateUser(java.lang.String username,
                    CallContext context)
             throws SecurityApiException

Invalidate a user

Parameters:

username - the username

context - context (does not include tenant nor account info)

Throws:

SecurityApiException

getUserRoles

java.util.List<java.lang.String> getUserRoles(java.lang.String username,
                                              TenantContext tenantContext)
                                       throws SecurityApiException

Retrieves the roles associated to a user in the Shiro store (JDBCRealm)

Parameters:

username - the username

tenantContext - dummy context

Returns:

roles for a specific user

Throws:

SecurityApiException

addRoleDefinition

void addRoleDefinition(java.lang.String role,
                       java.util.List<java.lang.String> permissions,
                       CallContext context)
                throws SecurityApiException

Add a role definition in the Shiro store (JDBCRealm)

Parameters:

role - the role name

permissions - the list of permissions

context - context (does not include tenant nor account info)

Throws:

SecurityApiException

See Also:

Permission

updateRoleDefinition

void updateRoleDefinition(java.lang.String role,
                          java.util.List<java.lang.String> permissions,
                          CallContext context)
                   throws SecurityApiException

Throws:

SecurityApiException

getRoleDefinition

java.util.List<java.lang.String> getRoleDefinition(java.lang.String role,
                                                   TenantContext tenantContext)

Retrieves the list of permissions associated to that role in the Shiro store (JDBCRealm)

Parameters:

role - the role name

tenantContext - dummy context

Returns: