Authenticator (Tyrus 2.2.0-M1 API)

java.lang.Object
- org.glassfish.tyrus.client.auth.Authenticator

```
@Beta
public abstract class Authenticator
extends java.lang.Object
```
Authenticator provides a way how to plug-in custom authentication provider.
Authenticator is called when server-side returns HTTP 401 as a reply to handshake response. Tyrus client then looks for authenticator instance registered to authentication scheme provided by server.

Author:

Ondrej Kosatka

See Also:

AuthConfig.Builder.registerAuthProvider(String, Authenticator), ClientProperties.AUTH_CONFIG, ClientProperties.CREDENTIALS

Constructor Summary

Constructors
Constructor Description

Authenticator()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract java.lang.String`	`generateAuthorizationHeader(java.net.URI uri, java.lang.String wwwAuthenticateHeader, Credentials credentials)`	Generate value used as ""Authorization"" header value for next request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Authenticator
```
public Authenticator()
```
- Method Detail
  - generateAuthorizationHeader
```
public abstract java.lang.String generateAuthorizationHeader(java.net.URI uri,
                                                             java.lang.String wwwAuthenticateHeader,
                                                             Credentials credentials)
                                                      throws AuthenticationException
```
    Generate value used as ""Authorization"" header value for next request.
    Thrown AuthenticationException will be wrapped as DeploymentException and thrown as a result of WebSocketContainer.connectToServer(...) method call.
    
    Parameters:
    
    uri - Uri of the server endpoint.
    
    wwwAuthenticateHeader - ""WWW-Authenticate"" header value received in a handshake response.
    
    credentials - credentials passed by property ClientProperties.CREDENTIALS. Can be null when there were no Credentials registered.
    
    Returns:
    
    value for "Authorization" header which will be put into next handshake request.
    
    Throws:
    
    AuthenticationException - when it is not possible to create ""Authorization"" header.