com.whizzosoftware.hobson.api.security

Interface AccessManager

public interface AccessManager

Interface for managing authentication and authorization for the Hub.

Author:

Dan Noguerol

Method Summary

Modifier and Type	Method and Description
void	addUser(java.lang.String userId, java.lang.String password, java.lang.String givenName, java.lang.String familyName, java.util.Collection<java.lang.String> roles) Add a new user.
HobsonUser	authenticate(java.lang.String token) Authenticates a user.
HobsonUser	authenticate(java.lang.String userId, java.lang.String password) Authenticates a user.
void	authorize(HobsonUser user, java.lang.String action, java.lang.String resource) Authorizes a user's access to an action/resource combination.
void	changeUserPassword(java.lang.String userId, PasswordChange password) Changes the password for a user.
java.lang.String	createToken(HobsonUser user) Creates a token for a user.
java.lang.String	getDefaultUser() Returns the default user if one is available.
java.util.Collection<java.lang.String>	getHubsForUser(java.lang.String userId) Returns the hubs associated with a user.
OIDCConfig	getOIDCConfig() Returns the OpenID Connect configuration.
java.util.Set<java.lang.String>	getRoles() Returns all the valid roles that can be assigned to a user.
HobsonUser	getUser(java.lang.String userId) Returns details about a user.
java.util.Collection<HobsonUser>	getUsers() Returns all users in the user store.
boolean	hasDefaultUser() Indicates whether this access manager has a default user (e.g.
boolean	isFederated() Indicates whether this access manager is fronting a federated identity provider.

Method Detail

addUser

void addUser(java.lang.String userId,
             java.lang.String password,
             java.lang.String givenName,
             java.lang.String familyName,
             java.util.Collection<java.lang.String> roles)

Add a new user.

Parameters:

userId - the user ID

password - the password

givenName - the user's first name

familyName - the user's last name

roles - the roles assigned to the user

authenticate

HobsonUser authenticate(java.lang.String userId,
                        java.lang.String password)
                 throws HobsonAuthenticationException

Authenticates a user.

Parameters:

userId - the user ID

password - the password

Returns:

a HobsonUser instance representing the authenticated user

Throws:

HobsonAuthenticationException - if the user ID/password combination are invalid

authenticate

HobsonUser authenticate(java.lang.String token)
                 throws HobsonAuthenticationException

Authenticates a user.

Parameters:

token - a token

Returns:

a HobsonUser instance representing the authenticated user

Throws:

HobsonAuthenticationException - if the token is invalid

authorize

void authorize(HobsonUser user,
               java.lang.String action,
               java.lang.String resource)
        throws HobsonAuthorizationException

Authorizes a user's access to an action/resource combination.

Parameters:

user - the user being checked

action - the action that is being performed

resource - the resource the action is being attempted against

Throws:

HobsonAuthorizationException - if the user is not authorized

changeUserPassword

void changeUserPassword(java.lang.String userId,
                        PasswordChange password)

Changes the password for a user.

Parameters:

userId - the user ID

password - the new password

createToken

java.lang.String createToken(HobsonUser user)

Creates a token for a user.

Parameters:

user - the user

Returns:

the token

getDefaultUser

java.lang.String getDefaultUser()

Returns the default user if one is available. If a default user exists, it is used when only a password is provided at authentication time.

Returns:

a user ID

getHubsForUser

java.util.Collection<java.lang.String> getHubsForUser(java.lang.String userId)

Returns the hubs associated with a user.

Parameters:

userId - the user ID

Returns:

a Collection of hub IDs (or null if the user has no hubs)

getOIDCConfig

OIDCConfig getOIDCConfig()

Returns the OpenID Connect configuration.

Returns:

an OIDCConfig instance

getRoles

java.util.Set<java.lang.String> getRoles()

Returns all the valid roles that can be assigned to a user.

Returns:

a Set of Strings

getUser

HobsonUser getUser(java.lang.String userId)

Returns details about a user.

Parameters:

userId - the user ID

Returns:

a HobsonUser instance

getUsers

java.util.Collection<HobsonUser> getUsers()

Returns all users in the user store.

Returns:

a Collection of HobsonUser instances

hasDefaultUser

boolean hasDefaultUser()

Indicates whether this access manager has a default user (e.g. getDefaultUser() would not return null).

Returns:

a boolean

isFederated

boolean isFederated()

Indicates whether this access manager is fronting a federated identity provider.

Returns:

a boolean