com.sleepycat.je.rep.subscription

Interface StreamAuthenticator

public interface StreamAuthenticator

Object represents an interface to authenticate stream consumer and check its access privilege.

Field Summary

Fields

Modifier and Type	Field and Description
static long	SECURITY_FAILURE_WAIT_TIME_MS Server wait time in ms before drop connection if authentication fails

Method Summary

Modifier and Type	Method and Description
boolean	authenticate() Returns whether the current token is valid.
boolean	checkAccess() Returns whether the current token is valid and grants access to the current table Ids.
long	getLastCheckTimeMs() Gets the time stamp of last check.
void	setTableIds(String[] tableIds) Specifies the table Ids.
void	setToken(byte[] token) Specifies the login token.

Field Detail

SECURITY_FAILURE_WAIT_TIME_MS

static final long SECURITY_FAILURE_WAIT_TIME_MS

Server wait time in ms before drop connection if authentication fails

See Also:

Constant Field Values

Method Detail

setToken

void setToken(byte[] token)

Specifies the login token.

Parameters:

token - login token in bytes

setTableIds

void setTableIds(String[] tableIds)

Specifies the table Ids. The table Ids are passed from stream consumer as string form. Each of the table id strings uniquely identifies a subscribed table.

Parameters:

tableIds - set of subscribed table id strings

authenticate

boolean authenticate()

Returns whether the current token is valid.

Returns:

true if currently stored token is valid, false otherwise.

checkAccess

boolean checkAccess()

Returns whether the current token is valid and grants access to the current table Ids.

Returns:

true if owner of current token is valid and has enough privileges to stream updates from subscribed tables, false otherwise.

getLastCheckTimeMs

long getLastCheckTimeMs()

Gets the time stamp of last check. Implementation of this interface shall remember the time stamp of each check, regardless of the check result. It shall return 0 if no previous check has been performed. The caller can determine if a security check has been performed in the last certain milliseconds by subtracting this value from the current time.

Returns:

the time stamp of last check in milliseconds, 0 if no previous check has been performed.