com.taobao.api.internal.toplink.embedded.websocket.auth

Interface Authenticator

All Known Implementing Classes:

AbstractAuthenticator, BasicAuthenticator, DefaultAuthenticator, DigestAuthenticator

public interface Authenticator

The Interface of ProxyCredentials.

Author:

t-hashimoto

Method Summary

Modifier and Type	Method and Description
void	done() finish authenticate phase.
String	getCredentials(String method, String requestUri, HttpHeader header, String authenticateHeaderName) Gets the credentials.
void	init(WebSocket websocket, Credentials credentials) inits authenticator
boolean	isDone()
boolean	isNeedAuthenticate()

Method Detail

getCredentials

String getCredentials(String method,
                      String requestUri,
                      HttpHeader header,
                      String authenticateHeaderName)
               throws WebSocketException

Gets the credentials.

Parameters:

method - request method GET,POST,CONNECT(proxy)

requestUri - the request uri

header - http header

authenticateHeaderName - the authenticate header name

Returns:

the credentials

Throws:

WebSocketException - the web socket exception

init

void init(WebSocket websocket,
          Credentials credentials)

inits authenticator

Parameters:

websocket - the websocket

credentials - the credentials

done

void done()

finish authenticate phase. if retry authenticate, need to create a new Authenticator instance.

isNeedAuthenticate

boolean isNeedAuthenticate()

isDone

boolean isDone()