org.infoglue.cms.security
Interface AuthorizationModule

All Known Implementing Classes:
CombinedJDBCBasicAuthorizationModule, CombinedJNDIBasicAuthorizationModule, GenericCombinedAuthorizationModule, InfoGlueBasicAuthorizationModule, InfoGlueJDBCAuthorizationModule, JNDIBasicAuthorizationModule, SimplifiedJNDIBasicAuthorizationModule, WebServiceAuthorizationModule

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

boolean getSupportUpdate()
Gets is the implementing class can update as well as read


getSupportDelete

boolean getSupportDelete()
Gets is the implementing class can delete as well as read


getSupportCreate

boolean getSupportCreate()
Gets is the implementing class can create as well as read


getAuthorizedInfoGluePrincipal

InfoGluePrincipal getAuthorizedInfoGluePrincipal(java.lang.String userName)
                                                 throws java.lang.Exception
Gets an authorized InfoGluePrincipal

Throws:
java.lang.Exception

getAuthorizedInfoGlueRole

InfoGlueRole getAuthorizedInfoGlueRole(java.lang.String roleName)
                                       throws java.lang.Exception
Gets an InfoGlueRole

Throws:
java.lang.Exception

getAuthorizedInfoGlueGroup

InfoGlueGroup getAuthorizedInfoGlueGroup(java.lang.String groupName)
                                         throws java.lang.Exception
Gets an InfoGlueGroup

Throws:
java.lang.Exception

authorizeUser

java.util.List authorizeUser(java.lang.String userName)
                             throws java.lang.Exception
This method is used to fetch a users roles.

Throws:
java.lang.Exception

getRoles

java.util.List getRoles()
                        throws java.lang.Exception
This method is used to fetch all available roles.

Throws:
java.lang.Exception

getGroups

java.util.List getGroups()
                         throws java.lang.Exception
This method is used to fetch all available groups.

Throws:
java.lang.Exception

getUsers

java.util.List getUsers()
                        throws java.lang.Exception
This method is used to fetch all users.

Throws:
java.lang.Exception

getUsers

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.

Throws:
java.lang.Exception

getRoleUsers

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.

Throws:
java.lang.Exception

getGroupUsers

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.

Throws:
java.lang.Exception

getFilteredUsers

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 java.lang.Exception
This method is used to get a filtered list of all users.

Parameters:
firstName -
lastName -
userName -
email -
roleIds -
Returns:
Throws:
SystemException
Bug
java.lang.Exception

createInfoGluePrincipal

void createInfoGluePrincipal(SystemUserVO systemUserVO)
                             throws java.lang.Exception
This method is used to create a new user.

Throws:
java.lang.Exception

updateInfoGluePrincipal

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.

Throws:
java.lang.Exception

updateInfoGluePrincipalPassword

void updateInfoGluePrincipalPassword(java.lang.String userName)
                                     throws java.lang.Exception
This method is used to send out a newpassword to an existing users.

Throws:
java.lang.Exception

updateInfoGluePrincipalPassword

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.

Throws:
java.lang.Exception

deleteInfoGluePrincipal

void deleteInfoGluePrincipal(java.lang.String userName)
                             throws java.lang.Exception
This method is used to delete an existing user.

Throws:
java.lang.Exception

createInfoGlueRole

void createInfoGlueRole(RoleVO roleVO)
                        throws java.lang.Exception
This method is used to create a new rol.

Throws:
java.lang.Exception

updateInfoGlueRole

void updateInfoGlueRole(RoleVO roleVO,
                        java.lang.String[] userNames)
                        throws java.lang.Exception
This method is used to update an existing role.

Throws:
java.lang.Exception

deleteInfoGlueRole

void deleteInfoGlueRole(java.lang.String roleName)
                        throws java.lang.Exception
This method is used to delete an existing role.

Throws:
java.lang.Exception

createInfoGlueGroup

void createInfoGlueGroup(GroupVO groupVO)
                         throws java.lang.Exception
This method is used to create a new group.

Throws:
java.lang.Exception

updateInfoGlueGroup

void updateInfoGlueGroup(GroupVO roleVO,
                         java.lang.String[] userNames)
                         throws java.lang.Exception
This method is used to update an existing group.

Throws:
java.lang.Exception

deleteInfoGlueGroup

void deleteInfoGlueGroup(java.lang.String groupName)
                         throws java.lang.Exception
This method is used to delete an existing group.

Throws:
java.lang.Exception

getExtraProperties

java.util.Properties getExtraProperties()

setExtraProperties

void setExtraProperties(java.util.Properties properties)

setTransactionObject

void setTransactionObject(java.lang.Object transactionObject)

getTransactionObject

java.lang.Object getTransactionObject()


Copyright © 2005 InfoGlue.org All Rights Reserved.