UserSourceProfileKernel

All Known Implementing Classes:

AbstractUserSourceProfile, ActiveDirectoryUserSource, ADInternalHybridUserSource, ADtoDBHybridAuthenticator, DatabaseAutomaticUserSource, DatabaseExpertUserSource, InternalUserSource, LockoutTrackingUserSourceProfileKernel, UserSourceProfileKernelImpl, UserSourceProfileKernelWrapper
```
public interface UserSourceProfileKernel
```
The nucleus of a User Source Profile. Instances are meant to be fixed and reused per user source profile. Useful for sharing between user source profile proxies.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`long`	`getCacheValidationTimeout()`
`GatewayContext`	`getContext()`
`default UserSourceManager`	`getManager()`
`long`	`getProfileId()`
`java.lang.String`	`getProfileName()`
`default boolean`	`isLockedOut(java.lang.String user)`
`default boolean`	`notifyFailedAttempt(java.lang.String user)`
`void`	`shutdown()`	Called either when the user source has been edited and so it is being restarted, or when the gateway is shutting down.
`void`	`startup(UserSourceManager manager)`	Called when the user source is created before it is used.

- Method Detail
  - getContext
```
GatewayContext getContext()
```
    Returns:
    
    the GatewayContext in which this UserSourceProfileKernel is running
  - getManager
```
default UserSourceManager getManager()
```
    Returns:
    
    the UserSourceManager running in this context
  - getProfileId
```
long getProfileId()
```
    Returns:
    
    the ID of this user source profile
  - getProfileName
```
java.lang.String getProfileName()
```
    Returns:
    
    the name of this user source profile
  - getCacheValidationTimeout
```
long getCacheValidationTimeout()
```
    Returns:
    
    the cache update time-out option
  - isLockedOut
```
default boolean isLockedOut(java.lang.String user)
```
    Parameters:
    
    user - the username of the user to check
    
    Returns:
    
    whether or not the user is locked out
  - notifyFailedAttempt
```
default boolean notifyFailedAttempt(java.lang.String user)
```
    Parameters:
    
    user - the username of the user who failed to authenticate
    
    Returns:
    
    whether or not the user is locked out after failing to authenticate
  - startup
```
void startup(UserSourceManager manager)
```
    Called when the user source is created before it is used.
  - shutdown
```
void shutdown()
```
    Called either when the user source has been edited and so it is being restarted, or when the gateway is shutting down.