com.sleepycat.je.rep.subscription

Interface SubscriptionAuthHandler

public interface SubscriptionAuthHandler

Object represents an interface of subscriber authenticator, used by subscriber to track token expiration and refresh token proactively.

Method Summary

Modifier and Type	Method and Description
byte[]	getToken() Returns the login token in bytes.
boolean	hasNewToken() Returns if subscriber has new token to update during subscription.

Method Detail

hasNewToken

boolean hasNewToken()
             throws ReplicationSecurityException

Returns if subscriber has new token to update during subscription. Subscriber need to update an existing token when 1) token will expire soon and need to to be renewed, or 2) token is unable to be renewed further and re-authenticate is needed to get a new token. Implementation of the interface shall check the two conditions above and refresh token if necessary.

Returns:

true if the subscriber has a new token to update, false otherwise.

Throws:

ReplicationSecurityException - if implementation of the interface fails to renew or re-authenticate to get a new token

getToken

byte[] getToken()

Returns the login token in bytes. It returns null if no identity information is available.

Returns:

login token as byte array, null if token is not available at the time of calling.