Style Intelligence v12.0

inetsoft.sree.security
Class AbstractEditableAuthenticationProvider

java.lang.Object
  extended by inetsoft.sree.security.AbstractAuthenticationProvider
      extended by inetsoft.sree.security.AbstractEditableAuthenticationProvider
All Implemented Interfaces:
AuthenticationProvider, EditableAuthenticationProvider
Direct Known Subclasses:
FileAuthenticationProvider, VirtualAuthenticationProvider

public abstract class AbstractEditableAuthenticationProvider
extends AbstractAuthenticationProvider
implements EditableAuthenticationProvider

Skeleton implementation of an editable authentication module.

Since:
8.5

Field Summary
 
Fields inherited from interface inetsoft.sree.security.AuthenticationProvider
INDIVIDUAL
 
Constructor Summary
AbstractEditableAuthenticationProvider()
           
 
Method Summary
 void addAuthenticationChangeListener(AuthenticationChangeListener l)
          Adds a listener that is notified when a security object is removed or renamed.
 void addGroup(Group group)
          Add a group to the system.
 void addRole(Role role)
          Add a role to the system.
 void addUser(User user)
          Add a user to the system.
 void changePassword(String user, String password)
          Change the password for an entity.
protected  void fireAuthenticationChanged(String oldName, String newName, int type, boolean removed)
          Notifies all registered listeners that a security object has been removed or renamed.
 void removeAuthenticationChangeListener(AuthenticationChangeListener l)
          Removes a change listener from the notification list.
 void removeGroup(String name)
          Remove a group from the system.
 void removeRole(String name)
          Remove a role from the system.
 void removeUser(String name)
          Remove a user from the system.
 void setGroup(String oname, Group group)
          Set group.
 void setRole(String oname, Role role)
          Set role.
 void setUser(String oname, User user)
          Set user.
 
Methods inherited from class inetsoft.sree.security.AbstractAuthenticationProvider
clearCache, findIdentity, getEmails, getGroup, getGroups, getIndividualUsers, getRole, getRoles, getRoles, getUser, getUsers, getUsers
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface inetsoft.sree.security.AuthenticationProvider
authenticate, findIdentity, getEmails, getGroup, getGroups, getIndividualUsers, getRole, getRoles, getRoles, getUser, getUsers, getUsers, tearDown
 

Constructor Detail

AbstractEditableAuthenticationProvider

public AbstractEditableAuthenticationProvider()
Method Detail

addUser

public void addUser(User user)
Add a user to the system.

Specified by:
addUser in interface EditableAuthenticationProvider
Parameters:
user - the user to add.

addGroup

public void addGroup(Group group)
Add a group to the system.

Specified by:
addGroup in interface EditableAuthenticationProvider
Parameters:
group - the group to add.

addRole

public void addRole(Role role)
Add a role to the system.

Specified by:
addRole in interface EditableAuthenticationProvider
Parameters:
role - the role to add.

setUser

public void setUser(String oname,
                    User user)
Set user.

Specified by:
setUser in interface EditableAuthenticationProvider
Parameters:
oname - old user name.
user - the new user.

setGroup

public void setGroup(String oname,
                     Group group)
Set group.

Specified by:
setGroup in interface EditableAuthenticationProvider
Parameters:
oname - old group name.
group - the new group.

setRole

public void setRole(String oname,
                    Role role)
Set role.

Specified by:
setRole in interface EditableAuthenticationProvider
Parameters:
oname - old role name.
role - the new role.

removeUser

public void removeUser(String name)
Remove a user from the system.

Specified by:
removeUser in interface EditableAuthenticationProvider
Parameters:
name - the name of the user to remove.

removeGroup

public void removeGroup(String name)
Remove a group from the system.

Specified by:
removeGroup in interface EditableAuthenticationProvider
Parameters:
name - the name of the group to remove.

removeRole

public void removeRole(String name)
Remove a role from the system.

Specified by:
removeRole in interface EditableAuthenticationProvider
Parameters:
name - the name of the role to remove.

changePassword

public void changePassword(String user,
                           String password)
                    throws SRSecurityException
Change the password for an entity. It is supportted only on security realms that use passwords.

Specified by:
changePassword in interface EditableAuthenticationProvider
Parameters:
user - the unique identifier of the user.
password - the new password.
Throws:
SRSecurityException - if the password could not be changed.

addAuthenticationChangeListener

public void addAuthenticationChangeListener(AuthenticationChangeListener l)
Adds a listener that is notified when a security object is removed or renamed.

Specified by:
addAuthenticationChangeListener in interface EditableAuthenticationProvider
Parameters:
l - the listener to add.

removeAuthenticationChangeListener

public void removeAuthenticationChangeListener(AuthenticationChangeListener l)
Removes a change listener from the notification list.

Specified by:
removeAuthenticationChangeListener in interface EditableAuthenticationProvider
Parameters:
l - the listener to remove.

fireAuthenticationChanged

protected void fireAuthenticationChanged(String oldName,
                                         String newName,
                                         int type,
                                         boolean removed)
Notifies all registered listeners that a security object has been removed or renamed.

Parameters:
oldName - the old name of the security object.
newName - the new name of the security object.
type - the type of the security object. The value of this parameter must be one of the type constants defined in Identity.
removed - true if the security object has been removed; false otherwise.

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.