Package org.opendaylight.aaa.shiro.idm

Class IdmLightProxy

java.lang.Object

org.opendaylight.aaa.shiro.idm.IdmLightProxy

All Implemented Interfaces:

ClaimCache, CredentialAuth<PasswordCredentials>, IdMService, PasswordCredentialAuth

@Singleton
public class IdmLightProxy
extends Object
implements PasswordCredentialAuth, IdMService, ClaimCache

An OSGi proxy for the IdmLight server.

Constructor Summary

Constructors

Constructor	Description
IdmLightProxy(IIDMStore idmStore, PasswordHashService passwordService)

Method Summary

Modifier and Type	Method	Description
Claim	authenticate(PasswordCredentials creds)	Authenticate a claim with the given credentials and domain scope.
void	clear()	Clears the cache of any active claims.
List<String>	listDomains(String userId)	List all domains that the given user has at least one role on.
List<String>	listRoles(String userId, String domainName)	List all roles that the given user has on the given domain.
List<String>	listUserIDs()	List all user IDs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opendaylight.aaa.api.PasswordCredentialAuth

credentialClass

Constructor Details

IdmLightProxy

@Inject
public IdmLightProxy(IIDMStore idmStore,
 PasswordHashService passwordService)

Method Details

authenticate

public Claim authenticate(PasswordCredentials creds)

Description copied from interface: CredentialAuth

Authenticate a claim with the given credentials and domain scope.

Specified by:

authenticate in interface CredentialAuth<PasswordCredentials>

Parameters:

creds - credentials

Returns:

authenticated claim

clear

public void clear()

Clears the cache of any active claims.

Specified by:

clear in interface ClaimCache

listDomains

public List<String> listDomains(String userId)

Description copied from interface: IdMService

List all domains that the given user has at least one role on.

Specified by:

listDomains in interface IdMService

Parameters:

userId - id of user

Returns:

list of all domains that the given user has access to

listRoles

public List<String> listRoles(String userId,
 String domainName)

Description copied from interface: IdMService

List all roles that the given user has on the given domain.

Specified by:

listRoles in interface IdMService

Parameters:

userId - id of user

domainName - name of domain

Returns:

list of roles

listUserIDs

public List<String> listUserIDs()
                         throws IDMStoreException

Description copied from interface: IdMService

List all user IDs.

Specified by:

listUserIDs in interface IdMService

Returns:

list of all user IDs

Throws:

IDMStoreException - if the user IDs could not be read from an IIDMStore