Package com.inductiveautomation.ignition.gateway.user

Class UserSourceProfileKernelWrapper

java.lang.Object

com.inductiveautomation.ignition.gateway.user.UserSourceProfileKernelWrapper

All Implemented Interfaces:

UserSourceProfileKernel

Direct Known Subclasses:

AbstractUserSourceProfile, LockoutTrackingUserSourceProfileKernel

public abstract class UserSourceProfileKernelWrapper
extends Object
implements UserSourceProfileKernel

Method Summary

Modifier and Type	Method	Description
long	getCacheValidationTimeout()
GatewayContext	getContext()
UserSourceManager	getManager()
long	getProfileId()
String	getProfileName()
boolean	isLockedOut(String user)
boolean	notifyFailedAttempt(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.

Methods inherited from class java.lang.Object

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

Method Details

getContext

public GatewayContext getContext()

Specified by:

getContext in interface UserSourceProfileKernel

Returns:

the GatewayContext in which this UserSourceProfileKernel is running

getManager

public UserSourceManager getManager()

Specified by:

getManager in interface UserSourceProfileKernel

Returns:

the UserSourceManager running in this context

getProfileId

public long getProfileId()

Specified by:

getProfileId in interface UserSourceProfileKernel

Returns:

the ID of this user source profile

getProfileName

public String getProfileName()

Specified by:

getProfileName in interface UserSourceProfileKernel

Returns:

the name of this user source profile

getCacheValidationTimeout

public long getCacheValidationTimeout()

Specified by:

getCacheValidationTimeout in interface UserSourceProfileKernel

Returns:

the cache update time-out option

isLockedOut

public boolean isLockedOut(String user)

Specified by:

isLockedOut in interface UserSourceProfileKernel

Parameters:

user - the username of the user to check

Returns:

whether or not the user is locked out

notifyFailedAttempt

public boolean notifyFailedAttempt(String user)

Specified by:

notifyFailedAttempt in interface UserSourceProfileKernel

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

public void startup(UserSourceManager manager)

Description copied from interface: UserSourceProfileKernel

Called when the user source is created before it is used.

Specified by:

startup in interface UserSourceProfileKernel

shutdown

public void shutdown()

Description copied from interface: UserSourceProfileKernel

Called either when the user source has been edited and so it is being restarted, or when the gateway is shutting down.

Specified by:

shutdown in interface UserSourceProfileKernel