org.infoglue.cms.security
Interface AuthorizationModule

All Known Implementing Classes:

InfoGlueBasicAuthorizationModule, JNDIBasicAuthorizationModule

public interface AuthorizationModule

This interface defines what a autorizationModule has to fulfill.

Author:

Mattias Bogeblad

Method Summary

java.util.List	authorizeUser(java.lang.String userName) This method is used to fetch a users roles.
void	createInfoGlueGroup(GroupVO groupVO) This method is used to create a new group.
void	createInfoGluePrincipal(SystemUserVO systemUserVO) This method is used to create a new user.
void	createInfoGlueRole(RoleVO roleVO) This method is used to create a new rol.
void	deleteInfoGlueGroup(java.lang.String groupName) This method is used to delete an existing group.
void	deleteInfoGluePrincipal(java.lang.String userName) This method is used to delete an existing user.
void	deleteInfoGlueRole(java.lang.String roleName) This method is used to delete an existing role.
InfoGlueGroup	getAuthorizedInfoGlueGroup(java.lang.String groupName) Gets an InfoGlueGroup
InfoGluePrincipal	getAuthorizedInfoGluePrincipal(java.lang.String userName) Gets an authorized InfoGluePrincipal
InfoGlueRole	getAuthorizedInfoGlueRole(java.lang.String roleName) Gets an InfoGlueRole
java.util.Properties	getExtraProperties()
java.util.List	getFilteredUsers(java.lang.String firstName, java.lang.String lastName, java.lang.String userName, java.lang.String email, java.lang.String[] roleIds) This method is used to get a filtered list of all users.
java.util.List	getGroups() This method is used to fetch all available groups.
java.util.List	getGroupUsers(java.lang.String groupName) This method is used to fetch all users part of the named group.
java.util.List	getRoles() This method is used to fetch all available roles.
java.util.List	getRoleUsers(java.lang.String roleName) This method is used to fetch all users part of the named role.
boolean	getSupportCreate() Gets is the implementing class can create as well as read
boolean	getSupportDelete() Gets is the implementing class can delete as well as read
boolean	getSupportUpdate() Gets is the implementing class can update as well as read
java.lang.Object	getTransactionObject()
java.util.List	getUsers() This method is used to fetch all users.
java.util.List	getUsers(java.lang.String roleName) Deprecated.
void	setExtraProperties(java.util.Properties properties)
void	setTransactionObject(java.lang.Object transactionObject)
void	updateInfoGlueGroup(GroupVO roleVO, java.lang.String[] userNames) This method is used to update an existing group.
void	updateInfoGluePrincipal(SystemUserVO systemUserVO, java.lang.String[] roleNames, java.lang.String[] groupNames) This method is used to update an existing user.
void	updateInfoGluePrincipalPassword(java.lang.String userName) This method is used to send out a newpassword to an existing users.
void	updateInfoGluePrincipalPassword(java.lang.String userName, java.lang.String oldPassword, java.lang.String newPassword) This method is used to send out a newpassword to an existing users.
void	updateInfoGlueRole(RoleVO roleVO, java.lang.String[] userNames) This method is used to update an existing role.

Method Detail

getSupportUpdate

public boolean getSupportUpdate()

Gets is the implementing class can update as well as read

getSupportDelete

public boolean getSupportDelete()

Gets is the implementing class can delete as well as read

getSupportCreate

public boolean getSupportCreate()

Gets is the implementing class can create as well as read

getAuthorizedInfoGluePrincipal

public InfoGluePrincipal getAuthorizedInfoGluePrincipal(java.lang.String userName)
                                                 throws java.lang.Exception

Gets an authorized InfoGluePrincipal

java.lang.Exception

getAuthorizedInfoGlueRole

public InfoGlueRole getAuthorizedInfoGlueRole(java.lang.String roleName)
                                       throws java.lang.Exception

Gets an InfoGlueRole

java.lang.Exception

getAuthorizedInfoGlueGroup

public InfoGlueGroup getAuthorizedInfoGlueGroup(java.lang.String groupName)
                                         throws java.lang.Exception

Gets an InfoGlueGroup

java.lang.Exception

authorizeUser

public java.util.List authorizeUser(java.lang.String userName)
                             throws java.lang.Exception

This method is used to fetch a users roles.

java.lang.Exception

getRoles

public java.util.List getRoles()
                        throws java.lang.Exception

This method is used to fetch all available roles.

java.lang.Exception

getGroups

public java.util.List getGroups()
                         throws java.lang.Exception

This method is used to fetch all available groups.

java.lang.Exception

getUsers

public java.util.List getUsers()
                        throws java.lang.Exception

This method is used to fetch all users.

java.lang.Exception

getUsers

public java.util.List getUsers(java.lang.String roleName)
                        throws java.lang.Exception

Deprecated.

This method is used to fetch all users part of the named role.

java.lang.Exception

getRoleUsers

public java.util.List getRoleUsers(java.lang.String roleName)
                            throws java.lang.Exception

This method is used to fetch all users part of the named role.

java.lang.Exception

getGroupUsers

public java.util.List getGroupUsers(java.lang.String groupName)
                             throws java.lang.Exception

This method is used to fetch all users part of the named group.

java.lang.Exception

getFilteredUsers

public java.util.List getFilteredUsers(java.lang.String firstName,
                                       java.lang.String lastName,
                                       java.lang.String userName,
                                       java.lang.String email,
                                       java.lang.String[] roleIds)
                                throws SystemException,
                                       Bug

This method is used to get a filtered list of all users.

Parameters:

firstName -

lastName -

userName -

email -

roleIds -

Returns:

Throws:

SystemException

Bug

createInfoGluePrincipal

public void createInfoGluePrincipal(SystemUserVO systemUserVO)
                             throws java.lang.Exception

This method is used to create a new user.

java.lang.Exception

updateInfoGluePrincipal

public void updateInfoGluePrincipal(SystemUserVO systemUserVO,
                                    java.lang.String[] roleNames,
                                    java.lang.String[] groupNames)
                             throws java.lang.Exception

This method is used to update an existing user.

java.lang.Exception

updateInfoGluePrincipalPassword

public void updateInfoGluePrincipalPassword(java.lang.String userName)
                                     throws java.lang.Exception

This method is used to send out a newpassword to an existing users.

java.lang.Exception

updateInfoGluePrincipalPassword

public void updateInfoGluePrincipalPassword(java.lang.String userName,
                                            java.lang.String oldPassword,
                                            java.lang.String newPassword)
                                     throws java.lang.Exception

This method is used to send out a newpassword to an existing users.

java.lang.Exception

deleteInfoGluePrincipal

public void deleteInfoGluePrincipal(java.lang.String userName)
                             throws java.lang.Exception

This method is used to delete an existing user.

java.lang.Exception

createInfoGlueRole

public void createInfoGlueRole(RoleVO roleVO)
                        throws java.lang.Exception

This method is used to create a new rol.

java.lang.Exception

updateInfoGlueRole

public void updateInfoGlueRole(RoleVO roleVO,
                               java.lang.String[] userNames)
                        throws java.lang.Exception

This method is used to update an existing role.

java.lang.Exception

deleteInfoGlueRole

public void deleteInfoGlueRole(java.lang.String roleName)
                        throws java.lang.Exception

This method is used to delete an existing role.

java.lang.Exception

createInfoGlueGroup

public void createInfoGlueGroup(GroupVO groupVO)
                         throws java.lang.Exception

This method is used to create a new group.

java.lang.Exception

updateInfoGlueGroup

public void updateInfoGlueGroup(GroupVO roleVO,
                                java.lang.String[] userNames)
                         throws java.lang.Exception

This method is used to update an existing group.

java.lang.Exception

deleteInfoGlueGroup

public void deleteInfoGlueGroup(java.lang.String groupName)
                         throws java.lang.Exception

This method is used to delete an existing group.

java.lang.Exception

getExtraProperties

public java.util.Properties getExtraProperties()

setExtraProperties

public void setExtraProperties(java.util.Properties properties)

setTransactionObject

public void setTransactionObject(java.lang.Object transactionObject)

getTransactionObject

public java.lang.Object getTransactionObject()