com.laserfiche.repository.api.clients.impl

Class ServerSessionClientImpl

java.lang.Object

com.laserfiche.repository.api.clients.impl.ApiClient

com.laserfiche.repository.api.clients.impl.ServerSessionClientImpl

All Implemented Interfaces:

ServerSessionClient

public class ServerSessionClientImpl
extends ApiClient
implements ServerSessionClient

The Laserfiche Repository ServerSession API client.

Field Summary

Fields inherited from class com.laserfiche.repository.api.clients.impl.ApiClient

baseUrl, httpClient, httpRequestHandler, objectMapper

Constructor Summary

Constructors

Constructor and Description
ServerSessionClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient, com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

Method Summary

Modifier and Type	Method and Description
ODataValueOfBoolean	createServerSession(ParametersForCreateServerSession parameters) - Deprecated.
ODataValueOfBoolean	invalidateServerSession(ParametersForInvalidateServerSession parameters) - Deprecated. - Invalidates the server session. - Acts as a "logout" operation, and invalidates the session associated with the provided access token.
ODataValueOfDateTime	refreshServerSession(ParametersForRefreshServerSession parameters) - Deprecated. - Refreshes the session associated with the access token.

Methods inherited from class com.laserfiche.repository.api.clients.impl.ApiClient

toJson

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerSessionClientImpl

public ServerSessionClientImpl(String baseUrl,
                               kong.unirest.UnirestInstance httpClient,
                               com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

Method Detail

invalidateServerSession

public ODataValueOfBoolean invalidateServerSession(ParametersForInvalidateServerSession parameters)

Description copied from interface: ServerSessionClient

- Deprecated.
- Invalidates the server session.
- Acts as a "logout" operation, and invalidates the session associated with the provided access token. This method should be used when the client wants to clean up the current session.
- Only available in Laserfiche Cloud.

Specified by:

invalidateServerSession in interface ServerSessionClient

Parameters:

parameters - An object of type ParametersForInvalidateServerSession which encapsulates the parameters of invalidateServerSession method.

Returns:

ODataValueOfBoolean The return value

createServerSession

public ODataValueOfBoolean createServerSession(ParametersForCreateServerSession parameters)

Description copied from interface: ServerSessionClient

- Deprecated. This function is a no-op, always returns 200.
- Only available in Laserfiche Cloud.

Specified by:

createServerSession in interface ServerSessionClient

Parameters:

parameters - An object of type ParametersForCreateServerSession which encapsulates the parameters of createServerSession method.

Returns:

ODataValueOfBoolean The return value

refreshServerSession

public ODataValueOfDateTime refreshServerSession(ParametersForRefreshServerSession parameters)

Description copied from interface: ServerSessionClient

- Deprecated.
- Refreshes the session associated with the access token. This is only necessary if you want to keep the same session alive, otherwise a new session will be automatically created when the session expires.
- When a client application wants to keep a session alive that has been idle for an hour, this route can be used to refresh the expiration timer associated with the access token.
- Only available in Laserfiche Cloud.

Specified by:

refreshServerSession in interface ServerSessionClient

Parameters:

parameters - An object of type ParametersForRefreshServerSession which encapsulates the parameters of refreshServerSession method.

Returns:

ODataValueOfDateTime The return value