org.wso2.carbon.device.mgt.output.adapter.websocket.authentication

Interface Authenticator

All Known Implementing Classes:

OAuthAuthenticator

public interface Authenticator

This interface is used to authenticate a websocket session

Method Summary

Methods

Modifier and Type	Method and Description
void	init(Map<String,String> globalProperties) This is used to initialize the authenticator
AuthenticationInfo	isAuthenticated(Map<String,List<String>> webSocketConnectionProperties) Check whether the client is authenticated to connect.

Method Detail

init

void init(Map<String,String> globalProperties)

This is used to initialize the authenticator

Parameters:

globalProperties - related to the output adapter

isAuthenticated

AuthenticationInfo isAuthenticated(Map<String,List<String>> webSocketConnectionProperties)

Check whether the client is authenticated to connect.

Returns:

AuthenticationInfo which contains authentication client information.