Package net.webpdf.wsclient.session.connection

Class SessionContext

java.lang.Object

net.webpdf.wsclient.session.connection.SessionContext

public class SessionContext
extends Object

An instance of SessionContext collects and provides advanced settings for the initialization of a webPDF Session. During it´s existence a Session will obey those settings, when making requests to a webPDF server.

Be aware: A Session will deduce it´s SessionContextSettings from a SessionContext. The SessionContextSettings of a running Session can not be changed.

Be aware: A SessionContext is not required to serve multiple Sessions at a time. It is expected to create a new SessionContext for each existing Session.

Constructor Summary

Constructors

Constructor	Description
SessionContext(@NotNull WebServiceProtocol webServiceProtocol, @NotNull URL url)	Instantiates a new SessionContext for Sessions. The constructor initializes the non-optional settings, that must be provided.

Method Summary

Modifier and Type	Method	Description
@Nullable ProxyConfiguration	getProxy()	Returns the ProxyConfiguration for Sessions. A ProxyConfiguration allows to route requests to the server via the defined proxy.
int	getSkewTime()	Returns a skew time for the token refresh of Sessions. The skew time helps to avoid using expired authorization tokens.
@Nullable TLSContext	getTlsContext()	Returns the TLSContext for Sessions. A TLSContext allows to send requests to the server via secured HTTPS connections.
@NotNull URL	getUrl()	Returns the URL of the server.
@NotNull WebServiceProtocol	getWebServiceProtocol()	Returns the WebServiceProtocol, that shall be used to communicate with the server.
@NotNull SessionContext	setProxy(@Nullable ProxyConfiguration proxyConfiguration)	Sets the ProxyConfiguration for Sessions. A ProxyConfiguration allows to route requests to the server via the defined proxy.
@NotNull SessionContext	setSkewTime(int skewTime)	Sets a skew time for the token refresh of Sessions. The skew time helps to avoid using expired authorization tokens.
@NotNull SessionContext	setTlsContext(@Nullable TLSContext tlsContext)	Sets the TLSContext for Sessions. A TLSContext allows to send requests to the server via secured HTTPS connections.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionContext

public SessionContext(@NotNull
                      @NotNull WebServiceProtocol webServiceProtocol,
                      @NotNull
                      @NotNull URL url)

Instantiates a new SessionContext for Sessions.
The constructor initializes the non-optional settings, that must be provided. All further settings are optional, and you may or may not require to set them.

Be aware: A Session will deduce it´s SessionContextSettings from a SessionContext. The SessionContextSettings of a running Session can not be changed.

Be aware: A SessionContext is not required to serve multiple Sessions at a time. It is expected to create a new SessionContext for each existing Session.

Parameters:

webServiceProtocol - The WebServiceProtocol used to communicate with the server.

url - The URL of the server.

Method Detail

getWebServiceProtocol

@NotNull
public @NotNull WebServiceProtocol getWebServiceProtocol()

Returns the WebServiceProtocol, that shall be used to communicate with the server.

Returns:

The WebServiceProtocol, that shall be used to communicate with the server.

getUrl

@NotNull
public @NotNull URL getUrl()

Returns the URL of the server.

Returns:

The URL of the server.

setTlsContext

@NotNull
public @NotNull SessionContext setTlsContext(@Nullable
                                             @Nullable TLSContext tlsContext)

Sets the TLSContext for Sessions.
A TLSContext allows to send requests to the server via secured HTTPS connections.

Parameters:

tlsContext - The TLSContext, that shall be used.

Returns:

This SessionFactory itself.

getTlsContext

@Nullable
public @Nullable TLSContext getTlsContext()

Returns the TLSContext for Sessions.
A TLSContext allows to send requests to the server via secured HTTPS connections.

Returns:

The TLSContext, that shall be used.

setProxy

@NotNull
public @NotNull SessionContext setProxy(@Nullable
                                        @Nullable ProxyConfiguration proxyConfiguration)

Sets the ProxyConfiguration for Sessions.
A ProxyConfiguration allows to route requests to the server via the defined proxy.

Parameters:

proxyConfiguration - The ProxyConfiguration, that shall be used.

Returns:

This SessionFactory itself.

getProxy

@Nullable
public @Nullable ProxyConfiguration getProxy()

Returns the ProxyConfiguration for Sessions.
A ProxyConfiguration allows to route requests to the server via the defined proxy.

Returns:

The ProxyConfiguration, that shall be used.

setSkewTime

@NotNull
public @NotNull SessionContext setSkewTime(int skewTime)

Sets a skew time for the token refresh of Sessions.
The skew time helps to avoid using expired authorization tokens. The returned value (in seconds) is subtracted from the expiry time to avoid issues possibly caused by transfer delays.
It can not be guaranteed, but is recommended, that custom implementations of AuthProvider handle this accordingly.

Parameters:

skewTime - The skew time in seconds, that shall be used.

Returns:

This SessionFactory itself.

getSkewTime

public int getSkewTime()

Returns a skew time for the token refresh of Sessions.
The skew time helps to avoid using expired authorization tokens. The returned value (in seconds) is subtracted from the expiry time to avoid issues possibly caused by transfer delays.
It can not be guaranteed, but is recommended, that custom implementations of AuthProvider handle this accordingly.

Returns:

The skew time in seconds, that shall be used.