Package net.webpdf.wsclient.session.auth

Interface OAuth2Provider

All Superinterfaces:

AuthProvider

public interface OAuth2Provider
extends AuthProvider

A class implementing OAuth2Provider shall implement a provide(Session) method to determine a OAuth2Token for the authorization of a Session.
This interface is directly intended to enable you, to implement your own custom authorization provider - refer to the wiki for examples.

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 OAuth2Token	provide(@NotNull Session session)	Provides an OAuth2Token for the authorization of a Session.
@NotNull OAuth2Token	refresh(@NotNull Session session)	Refresh authorization SessionToken for an active Session.

Method Detail

provide

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

Provides an OAuth2Token for the authorization of a Session.

Specified by:

provide in interface AuthProvider

Parameters:

session - The Session to provide authorization for.

Returns:

The OAuth2Token to authorize the Session with.

Throws:

AuthResultException - Shall be thrown, should the authorization fail for some reason. (Use AuthResultException to wrap exceptions, that might occur during your authorization request.)

refresh

@NotNull
@NotNull OAuth2Token refresh(@NotNull
                             @NotNull 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 OAuth2Token refreshed by this OAuth2Provider.

Throws:

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