Package net.webpdf.wsclient.session

Class SessionFactory

java.lang.Object

net.webpdf.wsclient.session.SessionFactory

public final class SessionFactory
extends Object

The SessionFactory provides the means to create a Session of a matching type, establishing and managing a connection with a webPDF server.

Be Aware: Should you not set an AuthProvider the AnonymousAuthProvider shall be used by default, and "anonymous sessions" may or may not be allowed by your webPDF server.
It is never possible to establish a session with the webPDF server without proper authorization.

Method Summary

Modifier and Type	Method	Description
static <T_SESSION extends Session> T_SESSION	createInstance(@NotNull SessionContext sessionContext)	Creates a HTTP or HTTPS Session with a webPDF server, based on the given SessionContext.
static <T_SESSION extends Session> T_SESSION	createInstance(@NotNull SessionContext sessionContext, @NotNull AuthProvider authProvider)	Creates a HTTP or HTTPS Session with a webPDF server, based on the given SessionContext and AuthProvider.

Methods inherited from class java.lang.Object

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

Method Detail

createInstance

@NotNull
public static <T_SESSION extends Session> T_SESSION createInstance(@NotNull
                                                                   @NotNull SessionContext sessionContext)
                                                            throws ResultException

Creates a HTTP or HTTPS Session with a webPDF server, based on the given SessionContext.

This factory will either produce a SoapWebServiceSession or a RestWebServiceSession. It is not fit to produce custom session types.

Be Aware: This shall implicitly use the AnonymousAuthProvider, and "anonymous sessions" may or may not be allowed by your webPDF server - you should check that first, before using this factory method.
It is never possible to establish a session with the webPDF server without proper authorization.

Be Aware: Neither SessionContext, nor AuthProvider are required to serve multiple Sessions at a time. It is expected to create a new SessionContext and AuthProvider per Session you create.

Parameters:

sessionContext - The SessionContext containing advanced options for the session initialization.

Returns:

The Session organizing the communication with the webPDF server.

Throws:

ResultException - Shall be thrown in case establishing the Session failed.

createInstance

@NotNull
public static <T_SESSION extends Session> T_SESSION createInstance(@NotNull
                                                                   @NotNull SessionContext sessionContext,
                                                                   @NotNull
                                                                   @NotNull AuthProvider authProvider)
                                                            throws ResultException

Creates a HTTP or HTTPS Session with a webPDF server, based on the given SessionContext and AuthProvider.

This factory will either produce a SoapWebServiceSession or a RestWebServiceSession. It is not fit to produce custom session types.

Be Aware: Neither SessionContext, nor AuthProvider are required to serve multiple Sessions at a time. It is expected to create a new SessionContext and AuthProvider per Session you create.

Parameters:

sessionContext - The SessionContext containing advanced options for the Session.

authProvider - The AuthProvider to use for authentication/authorization of the Session.

Returns:

The Session organizing the communication with the webPDF server.

Throws:

ResultException - Shall be thrown in case establishing the Session failed.