Package net.webpdf.wsclient.session.auth

Interface AuthProvider

All Known Subinterfaces:

OAuth2Provider

All Known Implementing Classes:

AbstractAuthenticationProvider, AnonymousAuthProvider, UserAuthProvider

public interface AuthProvider

A class implementing AuthProvider shall provide AuthMaterial for a Session via it´s provide(Session) method.

Be aware: 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.

Method Summary

Modifier and Type	Method	Description
@NotNull AuthMaterial	provide(@NotNull Session session)	Provides authorization SessionToken for a Session.
@NotNull AuthMaterial	refresh(Session session)	Refresh authorization SessionToken for an active Session.

Method Detail

provide

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

Provides authorization SessionToken for a Session.

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.

refresh

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

Refresh authorization SessionToken for an active Session.

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.