Package net.webpdf.wsclient.session.auth

Class UserAuthProvider

java.lang.Object

net.webpdf.wsclient.session.auth.AbstractAuthenticationProvider

net.webpdf.wsclient.session.auth.UserAuthProvider

All Implemented Interfaces:

AuthProvider

public class UserAuthProvider
extends AbstractAuthenticationProvider

An instance of UserAuthProvider shall provide UsernamePasswordCredentials for the authentication of a webPDF user.

Be aware: Currently an UserAuthProvider shall only serve one Session at a time. An UserAuthProvider 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 UserAuthProviders 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
UserAuthProvider(@NotNull String userName, char @NotNull [] password)	Creates a new UserAuthProvider provider for the given userName and password. Be aware: The given values may not be empty.
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)	Creates a new UserAuthProvider for the given userName and password. Be aware: The given values may not be empty.
UserAuthProvider(@NotNull String userName, @NotNull String password, AuthMaterial authMaterial)	Resumes an existing authentication provider, that shall resume a Session with the AuthMaterial provided.

Method Summary

Methods inherited from class net.webpdf.wsclient.session.auth.AbstractAuthenticationProvider

getAuthMaterial, getInitialAuthMaterial, getSession, login, provide, refresh, setAuthMaterial

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAuthProvider

public UserAuthProvider(@NotNull
                        @NotNull String userName,
                        @NotNull
                        @NotNull String password)
                 throws ResultException

Creates a new UserAuthProvider for the given userName and password.
Be aware: The given values may not be empty. Use the AnonymousAuthProvider to create anonymous Sessions.

Be aware: Currently an UserAuthProvider shall only serve one Session at a time. An UserAuthProvider 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 UserAuthProviders shall be reusable by subsequent Sessions.

Parameters:

userName - The name of the user to authenticate.

password - The password of the user to authenticate.

Throws:

ResultException

UserAuthProvider

public UserAuthProvider(@NotNull
                        @NotNull String userName,
                        @NotNull
                        @NotNull String password,
                        AuthMaterial authMaterial)
                 throws ResultException

Resumes an existing authentication provider, that shall resume a Session with the AuthMaterial provided.

Be aware: Currently an UserAuthProvider shall only serve one Session at a time. An UserAuthProvider 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 UserAuthProviders shall be reusable by subsequent Sessions.

Parameters:

userName - The name of the user to authenticate.

password - The password of the user to authenticate.

authMaterial - The AuthMaterial to resume the Session with.

Throws:

ResultException

UserAuthProvider

public UserAuthProvider(@NotNull
                        @NotNull String userName,
                        char @NotNull [] password)
                 throws ResultException

Creates a new UserAuthProvider provider for the given userName and password.
Be aware: The given values may not be empty. Use the AnonymousAuthProvider to create anonymous Sessions.

Be aware: Currently an UserAuthProvider shall only serve one Session at a time. An UserAuthProvider 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 UserAuthProviders shall be reusable by subsequent Sessions.

Parameters:

userName - The name of the user to authenticate.

password - The password of the user to authenticate.

Throws:

ResultException

UserAuthProvider

public UserAuthProvider(@NotNull
                        @NotNull String userName,
                        char @NotNull [] password,
                        AuthMaterial authMaterial)
                 throws ResultException

Resumes an existing authentication provider, that shall resume a Session with the AuthMaterial provided.

Be aware: Currently an UserAuthProvider shall only serve one Session at a time. An UserAuthProvider 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 UserAuthProviders shall be reusable by subsequent Sessions.

Parameters:

userName - The name of the user to authenticate.

password - The password of the user to authenticate.

authMaterial - The AuthMaterial to resume the Session with.

Throws:

ResultException