UserAuthenticator (Pusher Java Websocket API)

All Known Implementing Classes:

HttpUserAuthenticator
```
public interface UserAuthenticator
```
Sigining in as a User on a connection requires authentication. This interface provides an authenticate(java.lang.String) method as a mechanism for doing this.
See the HttpUserAuthenticator as an example.

- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  java.lang.String authenticate(java.lang.String socketId)
  Called when a user is to be authenticated.

- Method Detail
  - authenticate
```
java.lang.String authenticate(java.lang.String socketId)
                       throws AuthenticationFailureException
```
    Called when a user is to be authenticated.
    
    Parameters:
    
    socketId - A unique socket connection ID to be used with the authentication. This uniquely identifies the connection that on which the user is being authenticated.
    
    Returns:
    
    A user authentication token.
    
    Throws:
    
    AuthenticationFailureException - if the authentication fails.