Package net.webpdf.wsclient.session.connection

Class SessionContextSettings

java.lang.Object

net.webpdf.wsclient.session.connection.SessionContextSettings

public class SessionContextSettings
extends Object

An instance of SessionContextSettings collects and provides advanced settings for a webPDF Session. During it´s existence a Session will obey those settings, when making requests to a webPDF server.
Be aware: SessionContextSettings can not be changed post initialization. If you want to make such changes, you have to create a new Session using the SessionContext of your choice.

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

Constructor Summary

Constructors

Constructor	Description
SessionContextSettings(@NotNull SessionContext contextConfiguration)	Creates a new SessionContextSettings from the provided SessionContext.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionContextSettings

public SessionContextSettings(@NotNull
                              @NotNull SessionContext contextConfiguration)

Creates a new SessionContextSettings from the provided SessionContext. During it´s existence a Session will obey those settings, when making requests to a webPDF server.
Be aware: A SessionContextSettings can not be changed post initialization. You must use a SessionContext instance prior to the Session initialization, to manipulate those settings.

Parameters:

contextConfiguration - The SessionContext initializing this SessionContextSettings.

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.

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.

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.

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.