|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Realm
Method Summary | |
---|---|
void |
addRole(java.lang.String roleName)
Add a role to the userstore |
void |
addUser(java.lang.String userName,
java.lang.Object credential)
Add a user to the userstore. |
void |
addUserToRole(java.lang.String userName,
java.lang.String roleName)
Adds a User to the Role |
boolean |
authenticate(java.lang.String userName,
java.lang.Object credentials)
Authenticates a user against a userstore |
void |
authorizeRole(java.lang.String roleName,
java.lang.String resourceId,
java.lang.String action)
Allows the role to perform the given action on the given resource |
void |
authorizeUser(java.lang.String userName,
java.lang.String resourceId,
java.lang.String action)
Allows the user to perform the given action on the given resource |
void |
clearResourceAuthorizations(java.lang.String resourceId)
Removes all authorizations specified on a resource. |
void |
clearRoleAuthorization(java.lang.String roleName,
java.lang.String resourceId,
java.lang.String action)
Removes the "role, action, resource" relationship. |
void |
clearUserAuthorization(java.lang.String userName,
java.lang.String resourceId,
java.lang.String action)
Removes the "user, action, resource" relationship. |
void |
copyAuthorizations(java.lang.String fromResourceId,
java.lang.String toResourceId)
Copies all authorization of "fromResourceId" to "toResourceId". |
void |
deleteRole(java.lang.String roleName)
Delete role from userstore given the rolename. |
void |
deleteUser(java.lang.String userName)
Deletes a user in the userstore |
void |
denyRole(java.lang.String roleName,
java.lang.String resourceId,
java.lang.String action)
Blocks the role performing the given action on the given resource |
void |
denyUser(java.lang.String userName,
java.lang.String resourceId,
java.lang.String action)
Blocks the user performing the given action on the given resource |
java.lang.String[] |
getAllRoleNames()
Returns an array of all rolenames int the userstore |
java.lang.String[] |
getAllUserNames()
Returns an array of Usernames from the userstore |
java.lang.String[] |
getAuthorizedRolesForResource(java.lang.String resourceId,
java.lang.String action)
Returns a list of roles authorized to perform an action on a resource |
java.lang.String[] |
getAuthorizedUsersForResource(java.lang.String resourceId,
java.lang.String action)
Returns a list of users authorized to perform an action on a resource |
java.lang.Object |
getRealmConfiguration()
Returns the realm configuration bean. |
java.util.Map |
getRoleProperties(java.lang.String roleName)
Gets role property |
java.util.Map |
getUserProperties(java.lang.String userName)
Gets user property |
java.lang.String[] |
getUserRoles(java.lang.String userName)
Returns an array of Role given a user name |
void |
init(java.lang.Object configBean)
Initializes the realm using the properties from the configuration bean passed in. |
boolean |
isRoleAuthorized(java.lang.String roleName,
java.lang.String resourceId,
java.lang.String action)
Checks whether the role is allowed to perform the given action on the given resource |
boolean |
isUserAuthorized(java.lang.String userName,
java.lang.String resourceId,
java.lang.String action)
Checks whether the user is allowed to perform the given action on the given resource |
void |
removeUserFromRole(java.lang.String userName,
java.lang.String roleName)
Removes a user from role |
void |
setRoleProperties(java.lang.String roleName,
java.util.Map properties)
Sets role property |
void |
setUserProperties(java.lang.String userName,
java.util.Map properties)
Sets user property |
void |
updateUser(java.lang.String userName,
java.lang.Object credential)
Updates a user in the userstore. |
Method Detail |
---|
java.lang.Object getRealmConfiguration() throws UserManagerException
UserManagerException
- TODOvoid init(java.lang.Object configBean) throws UserManagerException
UserManagerException
- TODOvoid addUser(java.lang.String userName, java.lang.Object credential) throws UserManagerException
UserManagerException
void updateUser(java.lang.String userName, java.lang.Object credential) throws UserManagerException
UserManagerException
void deleteUser(java.lang.String userName) throws UserManagerException
UserManagerException
java.util.Map getUserProperties(java.lang.String userName) throws UserManagerException
UserManagerException
void setUserProperties(java.lang.String userName, java.util.Map properties) throws UserManagerException
UserManagerException
java.lang.String[] getAllUserNames() throws UserManagerException
UserManagerException
void addRole(java.lang.String roleName) throws UserManagerException
UserManagerException
void deleteRole(java.lang.String roleName) throws UserManagerException
UserManagerException
java.util.Map getRoleProperties(java.lang.String roleName) throws UserManagerException
UserManagerException
void setRoleProperties(java.lang.String roleName, java.util.Map properties) throws UserManagerException
UserManagerException
java.lang.String[] getAllRoleNames() throws UserManagerException
UserManagerException
java.lang.String[] getUserRoles(java.lang.String userName) throws UserManagerException
UserManagerException
void addUserToRole(java.lang.String userName, java.lang.String roleName) throws UserManagerException
UserManagerException
void removeUserFromRole(java.lang.String userName, java.lang.String roleName) throws UserManagerException
UserManagerException
boolean authenticate(java.lang.String userName, java.lang.Object credentials) throws UserManagerException
UserManagerException
void authorizeUser(java.lang.String userName, java.lang.String resourceId, java.lang.String action) throws UserManagerException
UserManagerException
void denyUser(java.lang.String userName, java.lang.String resourceId, java.lang.String action) throws UserManagerException
UserManagerException
boolean isUserAuthorized(java.lang.String userName, java.lang.String resourceId, java.lang.String action) throws UserManagerException
UserManagerException
void clearUserAuthorization(java.lang.String userName, java.lang.String resourceId, java.lang.String action) throws UserManagerException
UserManagerException
void authorizeRole(java.lang.String roleName, java.lang.String resourceId, java.lang.String action) throws UserManagerException
UserManagerException
void denyRole(java.lang.String roleName, java.lang.String resourceId, java.lang.String action) throws UserManagerException
UserManagerException
boolean isRoleAuthorized(java.lang.String roleName, java.lang.String resourceId, java.lang.String action) throws UserManagerException
UserManagerException
void clearRoleAuthorization(java.lang.String roleName, java.lang.String resourceId, java.lang.String action) throws UserManagerException
UserManagerException
void clearResourceAuthorizations(java.lang.String resourceId) throws UserManagerException
UserManagerException
java.lang.String[] getAuthorizedUsersForResource(java.lang.String resourceId, java.lang.String action) throws UserManagerException
UserManagerException
java.lang.String[] getAuthorizedRolesForResource(java.lang.String resourceId, java.lang.String action) throws UserManagerException
UserManagerException
void copyAuthorizations(java.lang.String fromResourceId, java.lang.String toResourceId) throws UserManagerException
UserManagerException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |