org.onosproject.ui

Interface UiTokenService

public interface UiTokenService

Service for handling UI session tokens.

Method Summary

Modifier and Type	Method and Description
UiSessionToken	issueToken(java.lang.String username) Issues a session token.
boolean	isTokenValid(UiSessionToken token) Returns true if the specified token is currently in the distributed map of valid UI session tokens.
void	revokeToken(UiSessionToken token) Revokes the specified session token.

Method Detail

issueToken

UiSessionToken issueToken(java.lang.String username)

Issues a session token. The service will generate a new token, publish it in the distributed map of valid UI session tokens, and return it to the caller.

Parameters:

username - the username to be associated with the token.

Returns:

the token

revokeToken

void revokeToken(UiSessionToken token)

Revokes the specified session token. The service will remove the token from the distributed map of valid UI session tokens.

Parameters:

token - the token to be revoked

isTokenValid

boolean isTokenValid(UiSessionToken token)

Returns true if the specified token is currently in the distributed map of valid UI session tokens.

Parameters:

token - the token to check

Returns:

true, if the token is currently valid; false otherwise