AuthMaterial (webPDF - Web service client library 9.0.1 API)

All Known Subinterfaces:

JWTToken

All Known Implementing Classes:

AnonymousMaterial, AuthenticationMaterial, OAuth2Token, SessionToken
```
public interface AuthMaterial
```
An instance of AuthMaterial provides information for the authentication getCredentials() and authorization getAuthHeader()/getRawAuthHeader() of a Session.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default @Nullable org.apache.hc.core5.http.Header`	`getAuthHeader()`	Builds and returns an authorization `Header` for a session. This may validly return `null` for anonymous `Session`s. Unless overridden, this method uses the result of `getRawAuthHeader()`.
`@Nullable org.apache.hc.client5.http.auth.Credentials`	`getCredentials()`	Provides `Credentials` for the authentication of a `Session`. This may validly return `null` for anonymous `Session`s, or in case an authentication is superfluous, because some other means is used to authorize the `Session`.
`@Nullable String`	`getRawAuthHeader()`	Returns the `String` value of an authorization header, that shall be used by a `Session`.
`@NotNull String`	`getToken()`	Returns the raw String token, that shall be passed to the authorization `Header`.

- Method Detail
  - getCredentials
```
@Nullable
@Nullable org.apache.hc.client5.http.auth.Credentials getCredentials()
```
    Provides Credentials for the authentication of a Session.
    This may validly return null for anonymous Sessions, or in case an authentication is superfluous, because some other means is used to authorize the Session.
    
    Returns:
    
    Credentials for the authentication of a Session.
  - getAuthHeader
```
@Nullable
default @Nullable org.apache.hc.core5.http.Header getAuthHeader()
```
    Builds and returns an authorization Header for a session.
    This may validly return null for anonymous Sessions.
    Unless overridden, this method uses the result of getRawAuthHeader().
    
    Returns:
    
    An authorization Header for a session.
    
    See Also:
    
    getRawAuthHeader()
  - getRawAuthHeader
```
@Nullable
@Nullable String getRawAuthHeader()
```
    Returns the String value of an authorization header, that shall be used by a Session.
    
    Returns:
    
    The String value of an authorization header, that shall be used by a Session.
  - getToken
```
@NotNull
@NotNull String getToken()
```
    Returns the raw String token, that shall be passed to the authorization Header.
    
    Returns:
    
    The raw String token, that shall be passed to the authorization Header.