org.apache.karaf.jaas.modules.properties

Class PropertiesBackingEngine

java.lang.Object

org.apache.karaf.jaas.modules.properties.PropertiesBackingEngine

All Implemented Interfaces:

BackingEngine

public class PropertiesBackingEngine
extends Object
implements BackingEngine

Field Summary

Fields inherited from interface org.apache.karaf.jaas.modules.BackingEngine

GROUP_PREFIX

Constructor Summary

Constructors

Constructor and Description
PropertiesBackingEngine(org.apache.felix.utils.properties.Properties users)
PropertiesBackingEngine(org.apache.felix.utils.properties.Properties users, EncryptionSupport encryptionSupport)

Method Summary

Modifier and Type	Method and Description
void	addGroup(String username, String group) Add a user into a given group.
void	addGroupRole(String group, String role) Add a role in a group.
void	addRole(String username, String role) Add a role to the user.
void	addUser(String username, String password) Create a new user.
void	createGroup(String group) Create a group
void	deleteGroup(String username, String group) Remove a user from a group.
void	deleteGroupRole(String group, String role) Remove a role from a group.
void	deleteRole(String username, String role) Remove a role from a user.
void	deleteUser(String username) Delete an user.
Map<org.apache.karaf.jaas.boot.principal.GroupPrincipal,String>	listGroups() List all groups.
List<org.apache.karaf.jaas.boot.principal.GroupPrincipal>	listGroups(org.apache.karaf.jaas.boot.principal.UserPrincipal user) List groups that a user is member of.
List<org.apache.karaf.jaas.boot.principal.RolePrincipal>	listRoles(Principal principal) List Roles for principal.
List<org.apache.karaf.jaas.boot.principal.UserPrincipal>	listUsers() List all users.
org.apache.karaf.jaas.boot.principal.UserPrincipal	lookupUser(String username) Retrieve the UserPrincipal corresponding to an username, or null if user doesn't exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertiesBackingEngine

public PropertiesBackingEngine(org.apache.felix.utils.properties.Properties users)

PropertiesBackingEngine

public PropertiesBackingEngine(org.apache.felix.utils.properties.Properties users,
                               EncryptionSupport encryptionSupport)

Method Detail

addUser

public void addUser(String username,
                    String password)

Description copied from interface: BackingEngine

Create a new user.

Specified by:

addUser in interface BackingEngine

Parameters:

username - the user name.

password - the user password.

deleteUser

public void deleteUser(String username)

Description copied from interface: BackingEngine

Delete an user.

Specified by:

deleteUser in interface BackingEngine

Parameters:

username - the user name.

listUsers

public List<org.apache.karaf.jaas.boot.principal.UserPrincipal> listUsers()

Description copied from interface: BackingEngine

List all users.

Specified by:

listUsers in interface BackingEngine

Returns:

the list of UserPrincipal.

lookupUser

public org.apache.karaf.jaas.boot.principal.UserPrincipal lookupUser(String username)

Description copied from interface: BackingEngine

Retrieve the UserPrincipal corresponding to an username, or null if user doesn't exist.

Specified by:

lookupUser in interface BackingEngine

Parameters:

username - The username.

Returns:

The UserPrincipal or null.

listRoles

public List<org.apache.karaf.jaas.boot.principal.RolePrincipal> listRoles(Principal principal)

Description copied from interface: BackingEngine

List Roles for principal. This could either be a UserPrincipal or a GroupPrincipal.

Specified by:

listRoles in interface BackingEngine

Parameters:

principal - the principal.

Returns:

the list of roles.

addRole

public void addRole(String username,
                    String role)

Description copied from interface: BackingEngine

Add a role to the user.

Specified by:

addRole in interface BackingEngine

Parameters:

username - the user name.

role - the role.

deleteRole

public void deleteRole(String username,
                       String role)

Description copied from interface: BackingEngine

Remove a role from a user.

Specified by:

deleteRole in interface BackingEngine

Parameters:

username - the user name.

role - the role.

listGroups

public List<org.apache.karaf.jaas.boot.principal.GroupPrincipal> listGroups(org.apache.karaf.jaas.boot.principal.UserPrincipal user)

Description copied from interface: BackingEngine

List groups that a user is member of.

Specified by:

listGroups in interface BackingEngine

Parameters:

user - the UserPrincipal.

Returns:

the list of GroupPrincipal.

addGroup

public void addGroup(String username,
                     String group)

Description copied from interface: BackingEngine

Add a user into a given group.

Specified by:

addGroup in interface BackingEngine

Parameters:

username - the user name.

group - the group.

deleteGroup

public void deleteGroup(String username,
                        String group)

Description copied from interface: BackingEngine

Remove a user from a group.

Specified by:

deleteGroup in interface BackingEngine

Parameters:

username - the user name.

group - the group.

addGroupRole

public void addGroupRole(String group,
                         String role)

Description copied from interface: BackingEngine

Add a role in a group.

Specified by:

addGroupRole in interface BackingEngine

Parameters:

group - the group.

role - the role.

deleteGroupRole

public void deleteGroupRole(String group,
                            String role)

Description copied from interface: BackingEngine

Remove a role from a group.

Specified by:

deleteGroupRole in interface BackingEngine

Parameters:

group - the group.

role - the role.

listGroups

public Map<org.apache.karaf.jaas.boot.principal.GroupPrincipal,String> listGroups()

Description copied from interface: BackingEngine

List all groups.

Specified by:

listGroups in interface BackingEngine

Returns:

the groups.

createGroup

public void createGroup(String group)

Description copied from interface: BackingEngine

Create a group

Specified by:

createGroup in interface BackingEngine

Parameters:

group - the group.