com.ibm.wsspi.security.authorization
Interface RoleConfiguration
- public interface RoleConfiguration
Method Summary
Modifier and Type | Method and Description |
---|---|
|
addAuthenticatedUsersToRole(java.lang.String role)
Add the all authenticated users to the role in RoleConfiguration.
|
|
addEveryoneToRole(java.lang.String role)
Add the everyone to the role in RoleConfiguration.
|
|
addGroupsToRole(java.lang.String role,java.util.List groups)
Add the groups to the role in RoleConfiguration.
|
|
addServerToRole(java.lang.String role)
Add the server to the role in RoleConfiguration.
|
|
addUsersToRole(java.lang.String role,java.util.List users)
Add the users to the role in RoleConfiguration.
|
|
commit()
This commits the changes in Roleconfiguration.
|
|
delete()
This deletes the RoleConfiguration from the RoleConfigurationFactory.
|
|
getContextID()
This returns the contextID of the RoleConfiguration.
|
|
removeAuthenticatedUsersFromRole(java.lang.String role)
Remove the all authenticated users to the role in RoleConfiguration.
|
|
removeEveryoneFromRole(java.lang.String role)
Remove the everyone to the role in RoleConfiguration.
|
|
removeGroupsFromRole(java.lang.String role,java.util.List groups)
Remove the groups to the role in RoleConfiguration.
|
|
removeServerFromRole(java.lang.String role)
Remove the server to the role in RoleConfiguration.
|
|
removeUsersFromRole(java.lang.String role,java.util.List users)
Remove the users to the role in RoleConfiguration.
|
Method Detail
addUsersToRole
- void addUsersToRole(java.lang.String role,
- java.util.List users)
- throws RoleConfigurationException
Add the users to the role in RoleConfiguration.
The role will be created, if it doesn't exist in RoleConfiguration.
Parameters:
role
- the role name. users
- the list of the user names. Throws:
RoleConfigurationException
- if the users can't be added. removeUsersFromRole
- void removeUsersFromRole(java.lang.String role,
- java.util.List users)
- throws RoleConfigurationException
Remove the users to the role in RoleConfiguration.
If the list users is null, delete all existing users from the role
Parameters:
role
- the role name. users
- the list of the user names. Throws:
RoleConfigurationException
- if the users can't be removed. addGroupsToRole
- void addGroupsToRole(java.lang.String role,
- java.util.List groups)
- throws RoleConfigurationException
Add the groups to the role in RoleConfiguration.
The role will be created, if it doesn't exist in RoleConfiguration.
Parameters:
role
- the role name. groups
- the list of the group names. Throws:
RoleConfigurationException
- if the groups can't be added. removeGroupsFromRole
- void removeGroupsFromRole(java.lang.String role,
- java.util.List groups)
- throws RoleConfigurationException
Remove the groups to the role in RoleConfiguration.
If the list groups is null, delete all existing groups from the role
Parameters:
role
- the role name. groups
- the list of the group names. Throws:
RoleConfigurationException
- if the groups can't be removed. addEveryoneToRole
- void addEveryoneToRole(java.lang.String role)
- throws RoleConfigurationException
Add the everyone to the role in RoleConfiguration.
The role will be created, if it doesn't exist in RoleConfiguration.
Parameters:
role
- the role name. Throws:
RoleConfigurationException
- if the everyone can't be added. removeEveryoneFromRole
- void removeEveryoneFromRole(java.lang.String role)
- throws RoleConfigurationException
Remove the everyone to the role in RoleConfiguration.
Parameters:
role
- the role name. Throws:
RoleConfigurationException
- if the everyone can't be removed. addAuthenticatedUsersToRole
- void addAuthenticatedUsersToRole( java.lang.String role)
- throws RoleConfigurationException
Add the all authenticated users to the role in RoleConfiguration.
The role will be created, if it doesn't exist in RoleConfiguration.
Parameters:
role
- the role name. Throws:
RoleConfigurationException
- if the authentication users
can't be added. removeAuthenticatedUsersFromRole
- void removeAuthenticatedUsersFromRole( java.lang.String role)
- throws RoleConfigurationException
Remove the all authenticated users to the role in RoleConfiguration.
Parameters:
role
- the role name. Throws:
RoleConfigurationException
- if the authentication users
can't be removed. addServerToRole
- void addServerToRole(java.lang.String role)
- throws RoleConfigurationException
Add the server to the role in RoleConfiguration.
The role will be created, if it doesn't exist in RoleConfiguration.
We may not use this interface in V6.0
Parameters:
role
- the role name. Throws:
RoleConfigurationException
- if the server can't
be added. removeServerFromRole
- void removeServerFromRole(java.lang.String role)
- throws RoleConfigurationException
Remove the server to the role in RoleConfiguration.
We may not use this interface in V6.0
Parameters:
role
- the role name. Throws:
RoleConfigurationException
- if the server can't
be removed. commit
- void commit()
- throws RoleConfigurationException
This commits the changes in Roleconfiguration.
Throws:
RoleConfigurationException
- if the changes can't be
committed. delete
- void delete()
- throws RoleConfigurationException
This deletes the RoleConfiguration from the RoleConfigurationFactory.
Throws:
RoleConfigurationException
- if the RoleConfiguration can't
be deleted. getContextID
- java.lang.String getContextID()
- throws RoleConfigurationException
This returns the contextID of the RoleConfiguration.
Throws:
RoleConfigurationException
- if the contextID can't be
gotten.