org.jboss.security.idm
Interface ProvisioningProvider

All Superinterfaces:
LoginProvider
All Known Implementing Classes:
LDAPIdentityProvider

public interface ProvisioningProvider
extends LoginProvider

The interface org.jboss.security.idm.ProvisioningProvider represents a data source component that extracts data from Identity Stores like LDAP repositories, ActiveX Directories, thirdparty identity management systems like SiteMinder, or even custom JDBC based systems.

ProvisioningProvider provides an abstraction for Identity Stores to extract Identity data related to Profile Management of users in the system.

The next release of SSO system will rely on ProvisioningProvider extensively to perform Federation User Provisioning for data stored in scattered Identity Stores.

Author:
Sohil Shah - sohil.shah@jboss.com - Sep 20, 2006

Method Summary
 void activate(Identity identity)
          Activates a user account
 void activate(java.lang.String username)
          Activates a user account
 void addRole(Role role)
          Adds a new role to the system
 void deactivate(Identity identity)
          Deactivates a user account
 void deactivate(java.lang.String username)
          Deactivates a user account
 boolean exists(Role role)
          Checks if the specified role exists in the system
 Role readRole(java.lang.String roleName)
          Reads role information for the specified role name
 void register(Identity identity)
          Registers a new user into the system
 void remove(Identity identity)
          Removes a user from the system
 void remove(java.lang.String username)
          Removes a user from the system
 void removeRole(Role role)
          Removes a role from the system
 void resetPassword(java.lang.String username, byte[] password)
          Resets the password of the specified user
 void update(Identity identity)
          Updates the user profile data
 void updateRole(Role role)
          Updates the specified role
 
Methods inherited from interface org.jboss.security.idm.LoginProvider
exists, exists, getId, login, login, processSSOLoginNotification, read, read, readAllRoles, setId, setProperties
 

Method Detail

activate

void activate(Identity identity)
              throws IdentityException
Activates a user account

Parameters:
identity - data of the user account that should be activated
Throws:
IdentityException

activate

void activate(java.lang.String username)
              throws IdentityException
Activates a user account

Parameters:
username - of the user account that should be activated
Throws:
IdentityException

deactivate

void deactivate(Identity identity)
                throws IdentityException
Deactivates a user account

Parameters:
identity - data of the user account that should be deactivated
Throws:
IdentityException

deactivate

void deactivate(java.lang.String username)
                throws IdentityException
Deactivates a user account

Parameters:
username - of the user account that should be deactivated
Throws:
IdentityException

update

void update(Identity identity)
            throws IdentityException
Updates the user profile data

Parameters:
identity -
Throws:
IdentityException

register

void register(Identity identity)
              throws IdentityException
Registers a new user into the system

Parameters:
identity -
Throws:
IdentityException

remove

void remove(Identity identity)
            throws IdentityException
Removes a user from the system

Parameters:
identity -
Throws:
IdentityException

remove

void remove(java.lang.String username)
            throws IdentityException
Removes a user from the system

Parameters:
username -
Throws:
IdentityException

resetPassword

void resetPassword(java.lang.String username,
                   byte[] password)
                   throws IdentityException
Resets the password of the specified user

Parameters:
username -
password -
Throws:
IdentityException

exists

boolean exists(Role role)
               throws IdentityException
Checks if the specified role exists in the system

Parameters:
role -
Returns:
Throws:
IdentityException

readRole

Role readRole(java.lang.String roleName)
              throws IdentityException
Reads role information for the specified role name

Parameters:
roleName -
Returns:
Throws:
IdentityException

addRole

void addRole(Role role)
             throws IdentityException
Adds a new role to the system

Parameters:
role -
Throws:
IdentityException

removeRole

void removeRole(Role role)
                throws IdentityException
Removes a role from the system

Parameters:
role -
Throws:
IdentityException

updateRole

void updateRole(Role role)
                throws IdentityException
Updates the specified role

Parameters:
role -
Throws:
IdentityException