io.warp10.continuum

Interface AuthenticationPlugin

public interface AuthenticationPlugin

Interface for authentication plugins to support alternate token types.

Method Summary

Modifier and Type	Method and Description
ReadToken	extractReadToken(java.lang.String token) This method attempts to extract a ReadToken from a provided token string.
WriteToken	extractWriteToken(java.lang.String token) This method attempts to extract a WriteToken from a provided token string.

Method Detail

extractReadToken

ReadToken extractReadToken(java.lang.String token)
                    throws WarpScriptException

This method attempts to extract a ReadToken from a provided token string. If the token string is not one the plugin can handle, this method MUST return null. If the token string can be handled by the plugin but is an invalid token, the method MUST throw a WarpScriptException

Parameters:

token - Token string to parse

Returns:

The extracted ReadToken instance or null if the token type is not supported by the plugin.

Throws:

WarpScriptException - If the provided token string is of the correct type but invalid.

extractWriteToken

WriteToken extractWriteToken(java.lang.String token)
                      throws WarpScriptException

This method attempts to extract a WriteToken from a provided token string. If the token string is not one the plugin can handle, this method MUST return null. If the token string can be handled by the plugin but is an invalid token, the method MUST throw a WarpScriptException

Parameters:

token - Token string to parse

Returns:

The extracted ReadToken instance or null if the token type is not supported by the plugin.

Throws:

WarpScriptException - If the provided token string is of the correct type but invalid.