Package net.webpdf.wsclient.session.auth.material

Class AuthenticationMaterial

java.lang.Object

net.webpdf.wsclient.session.auth.material.AuthenticationMaterial

All Implemented Interfaces:

AuthMaterial

public class AuthenticationMaterial
extends Object
implements AuthMaterial

An instance of AuthenticationMaterial serves to establish a user based Session with the webPDF server.
It shall both provide UsernamePasswordCredentials for a user, and a proper authorization Header to communicate the authentication attempt to the server.

Constructor Summary

Constructors

Constructor	Description
AuthenticationMaterial(@NotNull String user, char @NotNull [] password)	Instantiates fresh AuthenticationMaterial for the given user, using the given password.

Method Summary

Modifier and Type	Method	Description
@Nullable org.apache.hc.client5.http.auth.Credentials	getCredentials()	Returns the user´s UsernamePasswordCredentials.
@Nullable String	getRawAuthHeader()	Returns a new AuthMethod.BASIC_AUTHORIZATION header using the given UsernamePasswordCredentials.
@NotNull String	getToken()	Returns the raw String token, that shall be passed to the authorization Header.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.webpdf.wsclient.session.auth.material.AuthMaterial

getAuthHeader

Constructor Detail

AuthenticationMaterial

public AuthenticationMaterial(@NotNull
                              @NotNull String user,
                              char @NotNull [] password)

Instantiates fresh AuthenticationMaterial for the given user, using the given password.

Parameters:

user - The username to authenticate.

password - The password of the authenticated user.

Method Detail

getCredentials

@Nullable
public @Nullable org.apache.hc.client5.http.auth.Credentials getCredentials()

Returns the user´s UsernamePasswordCredentials.

Specified by:

getCredentials in interface AuthMaterial

Returns:

The user´s UsernamePasswordCredentials.

getRawAuthHeader

@Nullable
public @Nullable String getRawAuthHeader()

Returns a new AuthMethod.BASIC_AUTHORIZATION header using the given UsernamePasswordCredentials.

Specified by:

getRawAuthHeader in interface AuthMaterial

Returns:

A new AuthMethod.BASIC_AUTHORIZATION header using the given UsernamePasswordCredentials.

getToken

@NotNull
public @NotNull String getToken()

Returns the raw String token, that shall be passed to the authorization Header.

Specified by:

getToken in interface AuthMaterial

Returns:

The raw String token, that shall be passed to the authorization Header.