IdentityProviderPlugin (vertigo-account 3.4.0 API)

All Superinterfaces:

io.vertigo.core.node.component.CoreComponent, io.vertigo.core.node.component.Plugin

All Known Implementing Classes:

LdapIdentityProviderPlugin, StoreIdentityProviderPlugin, TextIdentityProviderPlugin
```
public interface IdentityProviderPlugin
extends io.vertigo.core.node.component.Plugin
```
Provider of Identities for external sources. Convert external entities to local User's model. IdentityProviders could be use to get users and store them in local system.

Author:

pchretien, npiedeloup

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`<E extends io.vertigo.datamodel.structure.model.Entity> List<E>`	`getAllUsers()`
`<E extends io.vertigo.datamodel.structure.model.Entity> Optional<VFile>`	`getPhoto(io.vertigo.datamodel.structure.model.UID<E> accountURI)`	Gets the photo of an account defined by its URI.
`<E extends io.vertigo.datamodel.structure.model.Entity> E`	`getUserByAuthToken(String userAuthToken)`	Gets an newly authentified account by his authToken.
`long`	`getUsersCount()`

- Method Detail
  - getUsersCount
```
long getUsersCount()
```
    Returns:
    
    the number of accounts
  - getAllUsers
```
<E extends io.vertigo.datamodel.structure.model.Entity> List<E> getAllUsers()
```
    Type Parameters:
    
    E - project's User entity type
    
    Returns:
    
    all users
  - getPhoto
```
<E extends io.vertigo.datamodel.structure.model.Entity> Optional<VFile> getPhoto(io.vertigo.datamodel.structure.model.UID<E> accountURI)
```
    Gets the photo of an account defined by its URI.
    
    Type Parameters:
    
    E - project's User entity type
    
    Parameters:
    
    accountURI - the account defined by its URI
    
    Returns:
    
    the photo as a file
  - getUserByAuthToken
```
<E extends io.vertigo.datamodel.structure.model.Entity> E getUserByAuthToken(String userAuthToken)
```
    Gets an newly authentified account by his authToken.
    
    Type Parameters:
    
    E - project's User entity type
    
    Parameters:
    
    userAuthToken - user authToken
    
    Returns:
    
    Logged account