Uses of Interface
net.webpdf.wsclient.session.auth.material.AuthMaterial

Packages that use AuthMaterial

Package	Description
net.webpdf.wsclient.session.auth
net.webpdf.wsclient.session.auth.material
net.webpdf.wsclient.session.auth.material.token
net.webpdf.wsclient.session.connection.http

Uses of AuthMaterial in net.webpdf.wsclient.session.auth

Methods in net.webpdf.wsclient.session.auth that return AuthMaterial

Modifier and Type	Method	Description
protected @NotNull AuthMaterial	AbstractAuthenticationProvider.getAuthMaterial()	Returns the currently used AuthMaterial.
@NotNull AuthMaterial	AbstractAuthenticationProvider.getInitialAuthMaterial()	Returns the initial AuthMaterial given to this AuthProvider.
protected @NotNull AuthMaterial	AbstractAuthenticationProvider.login(@NotNull Session session)	Login and provide authorization SessionToken for a Session.
@NotNull AuthMaterial	AbstractAuthenticationProvider.provide(@NotNull Session session)	Provides AuthMaterial for the authorization of a Session. Will attempt to produce a SessionToken for RestSessions. Will also refresh expired SessionTokens.
@NotNull AuthMaterial	AuthProvider.provide(@NotNull Session session)	Provides authorization SessionToken for a Session.
@NotNull AuthMaterial	AbstractAuthenticationProvider.refresh(Session session)	Refresh authorization SessionToken for an active Session.
@NotNull AuthMaterial	AuthProvider.refresh(Session session)	Refresh authorization SessionToken for an active Session.

Methods in net.webpdf.wsclient.session.auth with parameters of type AuthMaterial

Modifier and Type	Method	Description
protected void	AbstractAuthenticationProvider.setAuthMaterial(@NotNull AuthMaterial authMaterial)	Sets the used AuthMaterial.

Constructors in net.webpdf.wsclient.session.auth with parameters of type AuthMaterial

Constructor	Description
AbstractAuthenticationProvider(@NotNull AuthMaterial authMaterial)	Creates a fresh authentication provider, that shall initialize a Session using the given AuthMaterial. Be aware: possibly the given AuthMaterial will only be used during login and will be replaced with a SessionToken.
AbstractAuthenticationProvider(@NotNull AuthMaterial authMaterial, AuthMaterial resumeAuthMaterial)	Resumes an existing authentication provider, that shall resume a Session if a SessionToken is provided.
UserAuthProvider(@NotNull String userName, char @NotNull [] password, AuthMaterial authMaterial)	Resumes an existing authentication provider, that shall resume a Session with the AuthMaterial provided.
UserAuthProvider(@NotNull String userName, @NotNull String password, AuthMaterial authMaterial)	Resumes an existing authentication provider, that shall resume a Session with the AuthMaterial provided.

Uses of AuthMaterial in net.webpdf.wsclient.session.auth.material

Classes in net.webpdf.wsclient.session.auth.material that implement AuthMaterial

Modifier and Type	Class	Description
class	AnonymousMaterial	An instance of AnonymousMaterial serves to establish an anonymous Session via the AnonymousAuthProvider. None of the hereby implemented methods shall provide usable authentication or authorization material.
class	AuthenticationMaterial	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.

Uses of AuthMaterial in net.webpdf.wsclient.session.auth.material.token

Subinterfaces of AuthMaterial in net.webpdf.wsclient.session.auth.material.token

Modifier and Type	Interface	Description
interface	JWTToken	An instance of JWTToken wraps an access token that can be used to authorize a webPDF server Session.

Classes in net.webpdf.wsclient.session.auth.material.token that implement AuthMaterial

Modifier and Type	Class	Description
class	OAuth2Token	An instance of OAuth2Token wraps the access token of a webPDF Session in an object.
class	SessionToken	An instance of SessionToken wraps the access and refresh tokens provided by the webPDF server.

Uses of AuthMaterial in net.webpdf.wsclient.session.connection.http

Methods in net.webpdf.wsclient.session.connection.http with parameters of type AuthMaterial

Modifier and Type	Method	Description
@NotNull HttpRestRequest	HttpRestRequest.buildRequest(@NotNull HttpMethod httpMethod, @NotNull String path, @Nullable org.apache.hc.core5.http.HttpEntity httpEntity, @Nullable AuthMaterial authMaterial)	Prepare the HttpRestRequest to execute the selected HttpMethod on the given resource path (URI) and providing the given HttpEntity as it´s data transfer object (parameters).
@NotNull HttpRestRequest	HttpRestRequest.buildRequest(@NotNull HttpMethod httpMethod, @NotNull URI uri, @Nullable org.apache.hc.core5.http.HttpEntity httpEntity, @Nullable AuthMaterial authMaterial)	Prepare the HttpRestRequest to execute the selected HttpMethod on the given (URI) and providing the given HttpEntity as it´s data transfer object (parameters).