Style Intelligence v12.0

inetsoft.sree.security
Class AbstractAuthenticationProvider

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

public abstract class AbstractAuthenticationProvider
extends Object
implements AuthenticationProvider

A skeletal implementation of an authentication provider.

Since:
8.5

Field Summary
 
Fields inherited from interface inetsoft.sree.security.AuthenticationProvider
INDIVIDUAL
 
Constructor Summary
AbstractAuthenticationProvider()
           
 
Method Summary
 void clearCache()
          Clear the cached data.
 inetsoft.uql.util.Identity findIdentity(inetsoft.uql.util.Identity identity)
          Find the concrete identity in this security provider.
 String[] getEmails(String user)
          Deprecated. use User.getEmails() instead.
 Group getGroup(String name)
          Get a group by name.
 String[] getGroups()
          Get a list of all groups defined in the system.
 String[] getIndividualUsers()
          Get a list of all users not in any group except INDIVIDUAL.
 Role getRole(String name)
          Get a role object from the role ID.
 String[] getRoles()
          Get a list of all roles in the system.
 String[] getRoles(String user)
          Get a list of all roles bound to specific user.
 User getUser(String name)
          Get a user by name.
 String[] getUsers()
          Gets a list of all users in the system.
 String[] getUsers(String group)
          Get a list of all users in a group.
 
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, tearDown
 

Constructor Detail

AbstractAuthenticationProvider

public AbstractAuthenticationProvider()
Method Detail

getUsers

public String[] getUsers()
Gets a list of all users in the system.

Specified by:
getUsers in interface AuthenticationProvider
Returns:
a list of users.

getUser

public User getUser(String name)
Get a user by name.

Specified by:
getUser in interface AuthenticationProvider
Parameters:
name - the unique identifier of the user.
Returns:
the User object that encapsulates the properties of the user.

getEmails

public String[] getEmails(String user)
Deprecated. use User.getEmails() instead.

Get a list of all emails for a user.

Specified by:
getEmails in interface AuthenticationProvider
Parameters:
user - the unique identifier for the user.
Returns:
list of emails.

getGroup

public Group getGroup(String name)
Get a group by name.

Specified by:
getGroup in interface AuthenticationProvider
Parameters:
name - the name of the group.
Returns:
the named group or null if no such group exists.

getUsers

public String[] getUsers(String group)
Get a list of all users in a group.

Specified by:
getUsers in interface AuthenticationProvider
Parameters:
group - the name of the group, if the group is null returns users belongs no group.
Returns:
list of users

getIndividualUsers

public String[] getIndividualUsers()
Get a list of all users not in any group except INDIVIDUAL.

Specified by:
getIndividualUsers in interface AuthenticationProvider
Returns:
list of users

getRoles

public String[] getRoles()
Get a list of all roles in the system.

Specified by:
getRoles in interface AuthenticationProvider
Returns:
list of roles.

getRoles

public String[] getRoles(String user)
Get a list of all roles bound to specific user.

Specified by:
getRoles in interface AuthenticationProvider
Parameters:
user - the unique identifier for the user.
Returns:
list of roles.

getRole

public Role getRole(String name)
Get a role object from the role ID.

Specified by:
getRole in interface AuthenticationProvider
Parameters:
name - the name of the role.
Returns:
the named role object of null if no such role exists.

getGroups

public String[] getGroups()
Get a list of all groups defined in the system. If groups are nested, only the top level groups will be returned.

Specified by:
getGroups in interface AuthenticationProvider
Returns:
list of groups.

findIdentity

public final inetsoft.uql.util.Identity findIdentity(inetsoft.uql.util.Identity identity)
Find the concrete identity in this security provider.

Specified by:
findIdentity in interface AuthenticationProvider
Returns:
the identity found in this security provider, null otherewise.

clearCache

public void clearCache()
Clear the cached data.


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