org.josef.util.appserver

Interface ApplicationServerSecurityInterface

@Status(stage=PRODUCTION)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public interface ApplicationServerSecurityInterface

Interface for handling security for an application server.
Security consists of user and group management.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
void	addGroupToGroup(String groupName, String targetGroupName) Adds a group to a group.
void	addUserToGroup(String userName, String groupName) Adds a user to a group.
void	createGroup(String name, String description) Creates a new group.
void	createUser(String name, String password, String description) Creates a new user.
Set<String>	getGroupMembers(String groupName, String pattern, boolean includeNestedGroups) Gets the names of the users and groups that are members of the supplied groupName.
String	getUserDescription(String userName) Gets the description of the user with the supplied userName.
Set<String>	listUsers(String pattern) Gets the names of all the users that adhere to the supplied pattern.
void	removeGroup(String name) Removes an existing group.
void	removeGroupFromGroup(String groupName, String targetGroupName) Removes a group from a group.
void	removeUser(String name) Removes an existing user.
void	removeUserFromGroup(String userName, String groupName) Adds a user to a group.
void	updateGroup(String name, String description) Updates an existing group.
void	updateUser(String name, String password, String description) Updates an existing user.

Method Detail

listUsers

Set<String> listUsers(String pattern)
               throws MBeanException

Gets the names of all the users that adhere to the supplied pattern.

Parameters:

pattern - The pattern for which this method searches.
The pattern can end with an * (asterisk) as a wildcard, which matches any string of characters. The search is not case-sensitive.
For example, a pattern of abc matches exactly one name, a pattern of ab* matches all user names that start with ab, and a pattern of * matches all users.

Returns:

The names of all the users with a user name that adheres to the supplied pattern.
The returned set is possibly empty but it is never null!

Throws:

MBeanException - When the users could not be retrieved.

NullPointerException - When the supplied pattern is null.

IllegalArgumentException - When the supplied pattern is empty.

createUser

void createUser(String name,
                String password,
                String description)
         throws MBeanException

Creates a new user.

Parameters:

name - Name of the user.

password - Password of the user.
Note: The application server poses configurable restrictions, like the minimum length of the password.

description - Short description of this user.

Throws:

MBeanException - When the user could not be created.

NullPointerException - When either the supplied name or password is null.

IllegalArgumentException - When either the supplied name or password is empty.

updateUser

void updateUser(String name,
                String password,
                String description)
         throws MBeanException

Updates an existing user.

Parameters:

name - Name of the user.

password - Password of the user.
Note: The application server poses configurable restrictions, like the minimum length of the password.

description - Short description of this user.

Throws:

MBeanException - When the user could not be updated.

NullPointerException - When either the supplied name or password is null.

IllegalArgumentException - When either the supplied name or password is empty.

removeUser

void removeUser(String name)
         throws MBeanException

Removes an existing user.

Parameters:

name - Name of the user to remove.

Throws:

MBeanException - When the user could not be removed.

NullPointerException - When the supplied name is null.

IllegalArgumentException - When the supplied name is empty.

getUserDescription

String getUserDescription(String userName)
                   throws MBeanException

Gets the description of the user with the supplied userName.

Parameters:

userName - The name of the user for which the description should be retrieved.

Returns:

The description corresponding to the supplied userName.

Throws:

MBeanException - When the description could not be retrieved.

NullPointerException - When the supplied userName is null.

IllegalArgumentException - When the supplied userName is empty.

createGroup

void createGroup(String name,
                 String description)
          throws MBeanException

Creates a new group.

Parameters:

name - Name of the group.

description - Short description of this group.

Throws:

MBeanException - When the group could not be created.

NullPointerException - When the supplied name is null.

IllegalArgumentException - When the supplied name is empty.

updateGroup

void updateGroup(String name,
                 String description)
          throws MBeanException

Updates an existing group.

Parameters:

name - Name of the group.

description - Short description of this group.

Throws:

MBeanException - When the group could not be updated.

NullPointerException - When the supplied name is null.

IllegalArgumentException - When the supplied name is empty.

removeGroup

void removeGroup(String name)
          throws MBeanException

Removes an existing group.

Parameters:

name - Name of the group to remove.

Throws:

MBeanException - When the group could not be removed.

NullPointerException - When the supplied name is null.

IllegalArgumentException - When the supplied name is empty.

addUserToGroup

void addUserToGroup(String userName,
                    String groupName)
             throws MBeanException

Adds a user to a group.

Parameters:

userName - Name of the user.

groupName - Name of the group.

Throws:

MBeanException - When the user could not be added to the group.

NullPointerException - When either the supplied userName or groupName is null.

IllegalArgumentException - When either the supplied userName of groupName is empty.

removeUserFromGroup

void removeUserFromGroup(String userName,
                         String groupName)
                  throws MBeanException

Adds a user to a group.

Parameters:

userName - Name of the user.

groupName - Name of the group.

Throws:

MBeanException - When the user could not be removed from the group.

NullPointerException - When either the supplied userName or groupName is null.

IllegalArgumentException - When either the supplied userName or groupName is empty.

addGroupToGroup

void addGroupToGroup(String groupName,
                     String targetGroupName)
              throws MBeanException

Adds a group to a group.

Parameters:

groupName - Name of the group to add to the targetGroup.

targetGroupName - Name of the group to which the supplied groupName is added.

Throws:

MBeanException - When the group could not be added to the group.

NullPointerException - When either the supplied groupName or targetGroupName is null.

NullPointerException - When either the supplied groupName or targetGroupName is null.

removeGroupFromGroup

void removeGroupFromGroup(String groupName,
                          String targetGroupName)
                   throws MBeanException

Removes a group from a group.

Parameters:

groupName - Name of the group.

targetGroupName - Name of the group from which the supplied groupName is removed.

Throws:

MBeanException - When the group could not be removed from the group.

NullPointerException - When either the supplied groupName or targetGroupName is null.

NullPointerException - When either the supplied groupName or targetGroupName is null.

getGroupMembers

Set<String> getGroupMembers(String groupName,
                            String pattern,
                            boolean includeNestedGroups)
                     throws MBeanException

Gets the names of the users and groups that are members of the supplied groupName.

Parameters:

groupName - The name of an existing group within which this method searches for members

pattern - The pattern for which this method searches.
The pattern can end with an * (asterisk) as a wildcard, which matches any string of characters. The search is not case-sensitive.
For example, a pattern of abc matches exactly one name, a pattern of ab* matches all user and group names that start with ab, and a pattern of * matches all user and group names.

includeNestedGroups - Determines whether nested groups (true) are searched or not.

Returns:

A set of users/groups that are members of the supplied groupName.
The returned set is possibly empty but it is never null!

Throws:

MBeanException - When the group members could not be retrieved.

NullPointerException - When either the supplied groupName or pattern is null.

IllegalArgumentException - When either the supplied groupName or pattern is empty.