com.ibm.wsspi.security.authorization

Interface RoleConfiguration


  1. public interface RoleConfiguration

Method Summary

Modifier and Type Method and Description
  1. void
addAuthenticatedUsersToRole(java.lang.String role)
Add the all authenticated users to the role in RoleConfiguration.
  1. void
addEveryoneToRole(java.lang.String role)
Add the everyone to the role in RoleConfiguration.
  1. void
addGroupsToRole(java.lang.String role,java.util.List groups)
Add the groups to the role in RoleConfiguration.
  1. void
addServerToRole(java.lang.String role)
Add the server to the role in RoleConfiguration.
  1. void
addUsersToRole(java.lang.String role,java.util.List users)
Add the users to the role in RoleConfiguration.
  1. void
commit()
This commits the changes in Roleconfiguration.
  1. void
delete()
This deletes the RoleConfiguration from the RoleConfigurationFactory.
  1. java.lang.String
getContextID()
This returns the contextID of the RoleConfiguration.
  1. void
removeAuthenticatedUsersFromRole(java.lang.String role)
Remove the all authenticated users to the role in RoleConfiguration.
  1. void
removeEveryoneFromRole(java.lang.String role)
Remove the everyone to the role in RoleConfiguration.
  1. void
removeGroupsFromRole(java.lang.String role,java.util.List groups)
Remove the groups to the role in RoleConfiguration.
  1. void
removeServerFromRole(java.lang.String role)
Remove the server to the role in RoleConfiguration.
  1. void
removeUsersFromRole(java.lang.String role,java.util.List users)
Remove the users to the role in RoleConfiguration.

Method Detail

addUsersToRole

  1. void addUsersToRole(java.lang.String role,
  2. java.util.List users)
  3. 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

  1. void removeUsersFromRole(java.lang.String role,
  2. java.util.List users)
  3. 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

  1. void addGroupsToRole(java.lang.String role,
  2. java.util.List groups)
  3. 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

  1. void removeGroupsFromRole(java.lang.String role,
  2. java.util.List groups)
  3. 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

  1. void addEveryoneToRole(java.lang.String role)
  2. 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

  1. void removeEveryoneFromRole(java.lang.String role)
  2. 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

  1. void addAuthenticatedUsersToRole( java.lang.String role)
  2. 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

  1. void removeAuthenticatedUsersFromRole( java.lang.String role)
  2. 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

  1. void addServerToRole(java.lang.String role)
  2. 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

  1. void removeServerFromRole(java.lang.String role)
  2. 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

  1. void commit()
  2. throws RoleConfigurationException
This commits the changes in Roleconfiguration.
Throws:
RoleConfigurationException - if the changes can't be committed.

delete

  1. void delete()
  2. throws RoleConfigurationException
This deletes the RoleConfiguration from the RoleConfigurationFactory.
Throws:
RoleConfigurationException - if the RoleConfiguration can't be deleted.

getContextID

  1. java.lang.String getContextID()
  2. throws RoleConfigurationException
This returns the contextID of the RoleConfiguration.
Throws:
RoleConfigurationException - if the contextID can't be gotten.