Style Intelligence v12.0

inetsoft.sree.security
Interface AuthenticationProvider

All Known Subinterfaces:
EditableAuthenticationProvider, SecurityProvider
All Known Implementing Classes:
AbstractAuthenticationProvider, AbstractEditableAuthenticationProvider, AbstractSecurityProvider, CompositeSecurityProvider, FileAuthenticationProvider, FileSecurityProvider, VirtualAuthenticationProvider, VirtualSecurityProvider

public interface AuthenticationProvider

Interface for classes that provide authentication services to a security provider.

Since:
8.5

Field Summary
static String INDIVIDUAL
          This is a special group of users, which don't belong to any real group
 
Method Summary
 boolean authenticate(String user, Object credential)
          Check the authentication of specific entity.
 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 roleid)
          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()
          Get a list of all users in the system.
 String[] getUsers(String group)
          Get a list of all users in a group.
 void tearDown()
          Tear down the security provider.
 

Field Detail

INDIVIDUAL

static final String INDIVIDUAL
This is a special group of users, which don't belong to any real group

See Also:
Constant Field Values
Method Detail

getUser

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

Parameters:
name - the unique identifier of the user.
Returns:
the User object that encapsulates the properties of the user.

getUsers

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

Returns:
list of users.

getUsers

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

Parameters:
group - the name of the group.
Returns:
list of users

getEmails

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

Get a list of all emails for a user.

Parameters:
user - the unique identifier for the user.
Returns:
list of emails.

getIndividualUsers

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

Returns:
list of users

getRoles

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

Returns:
list of roles.

getRoles

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

Parameters:
user - the unique identifier for the user.
Returns:
list of roles.

getRole

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

Parameters:
roleid - the unique identifier of the role.
Returns:
the named role object of null if no such role exists.

getGroup

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

Parameters:
name - the name of the group.
Returns:
the named group or null if no such group exists.

getGroups

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

Returns:
list of groups.

authenticate

boolean authenticate(String user,
                     Object credential)
Check the authentication of specific entity.

Parameters:
user - the unique identification of the user.
credential - a wrapper for some secure message, such as the user ID and password. credential is of type String or DefaultTicket.
Returns:
true if the authentication succeeded.

findIdentity

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

Returns:
the identity found in this security provider, null otherwise.

tearDown

void tearDown()
Tear down the security provider.


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