Package net.webpdf.wsclient.session.auth

Class AbstractAuthenticationProvider

java.lang.Object

net.webpdf.wsclient.session.auth.AbstractAuthenticationProvider

All Implemented Interfaces:

AuthProvider

Direct Known Subclasses:

AnonymousAuthProvider, UserAuthProvider

public abstract class AbstractAuthenticationProvider
extends Object
implements AuthProvider

A class extending AbstractAuthenticationProvider shall provide the means to use the webPDF server´s login endpoint to authenticate a user. It shall also organize the automatic refresh of the SessionToken provided by the login endpoint and shall update it´s used AuthMaterial accordingly.

Be aware: Currently an AbstractAuthenticationProvider shall only serve one Session at a time. An AbstractAuthenticationProvider being called by another Session than it´s current master, shall assume it´s current master to have expired and shall, try to reauthorize that new Session (new master).
For that reason an AbstractAuthenticationProviders shall be reusable by subsequent Sessions.

Be aware: However - An implementation of AuthProvider is not required to serve multiple Sessions at a time. It is expected to create a new AuthProvider for each existing Session.

Constructor Summary

Constructors

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.

Method Summary

Modifier and Type	Method	Description
protected @NotNull AuthMaterial	getAuthMaterial()	Returns the currently used AuthMaterial.
@NotNull AuthMaterial	getInitialAuthMaterial()	Returns the initial AuthMaterial given to this AuthProvider.
@Nullable Session	getSession()	Returns the current Session this AuthProvider provides authorization for.
protected @NotNull AuthMaterial	login(@NotNull Session session)	Login and provide authorization SessionToken for a Session.
@NotNull AuthMaterial	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	refresh(Session session)	Refresh authorization SessionToken for an active Session.
protected void	setAuthMaterial(@NotNull AuthMaterial authMaterial)	Sets the used AuthMaterial.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAuthenticationProvider

public AbstractAuthenticationProvider(@NotNull
                                      @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.

Be aware: Currently an AbstractAuthenticationProvider shall only serve one Session at a time. An AbstractAuthenticationProvider being called by another Session than it´s current master, shall assume it´s current master to have expired and shall, try to reauthorize that new Session (new master).
For that reason an AbstractAuthenticationProviders shall be reusable by subsequent Sessions.

Parameters:

authMaterial - The AuthMaterial to initialize the Session with.

AbstractAuthenticationProvider

public AbstractAuthenticationProvider(@NotNull
                                      @NotNull AuthMaterial authMaterial,
                                      AuthMaterial resumeAuthMaterial)

Resumes an existing authentication provider, that shall resume a Session if a SessionToken is provided.

Be aware: Currently an AbstractAuthenticationProvider shall only serve one Session at a time. An AbstractAuthenticationProvider being called by another Session than it´s current master, shall assume it´s current master to have expired and shall, try to reauthorize that new Session (new master).
For that reason an AbstractAuthenticationProviders shall be reusable by subsequent Sessions.

Parameters:

authMaterial - The AuthMaterial to initialize the Session with.

resumeAuthMaterial - The AuthMaterial to resume the Session with.

Method Detail

getSession

@Nullable
public @Nullable Session getSession()

Returns the current Session this AuthProvider provides authorization for.

Returns:

The current Session this AuthProvider provides authorization for.

getInitialAuthMaterial

@NotNull
public @NotNull AuthMaterial getInitialAuthMaterial()

Returns the initial AuthMaterial given to this AuthProvider.

Returns:

The initial AuthMaterial given to this AuthProvider.

getAuthMaterial

@NotNull
protected @NotNull AuthMaterial getAuthMaterial()

Returns the currently used AuthMaterial.

Returns:

The currently used AuthMaterial.

setAuthMaterial

protected void setAuthMaterial(@NotNull
                               @NotNull AuthMaterial authMaterial)

Sets the used AuthMaterial.

Parameters:

authMaterial - The AuthMaterial to set.

refresh

@NotNull
public @NotNull AuthMaterial refresh(Session session)
                              throws AuthResultException

Refresh authorization SessionToken for an active Session.

Specified by:

refresh in interface AuthProvider

Parameters:

session - The session to refresh the authorization for.

Returns:

The AuthMaterial refreshed by this AuthProvider.

Throws:

AuthResultException - Shall be thrown, should the authentication/authorization fail for some reason.

login

@NotNull
protected @NotNull AuthMaterial login(@NotNull
                                      @NotNull Session session)
                               throws AuthResultException

Login and provide authorization SessionToken for a Session.

Parameters:

session - The session to provide the authorization for.

Returns:

The AuthMaterial provided by this AuthProvider.

Throws:

AuthResultException - Shall be thrown, should the authentication/authorization fail for some reason.

provide

@NotNull
public @NotNull AuthMaterial provide(@NotNull
                                     @NotNull Session session)
                              throws AuthResultException

Provides AuthMaterial for the authorization of a Session.
Will attempt to produce a SessionToken for RestSessions.
Will also refresh expired SessionTokens.

Be aware: Currently an AbstractAuthenticationProvider shall only serve one Session at a time. An AbstractAuthenticationProvider being called by another Session than it´s current master, shall assume it´s current master to have expired and shall, try to reauthorize that new Session (new master).
For that reason an AbstractAuthenticationProviders shall be reusable by subsequent Sessions.

Specified by:

provide in interface AuthProvider

Parameters:

session - The session to provide authorization for.

Returns:

The AuthMaterial provided by this AuthProvider.

Throws:

AuthResultException - Shall be thrown, should the authentication/authorization fail for some reason.