com.laserfiche.repository.api.clients.ServerSessionClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lf-repository-api-client Show documentation

Java implementation of various foundational APIs for Laserfiche, including Repository APIs such as Entry API flows for secure and easy access to Laserfiche Repository Entries.

The newest version!

package com.laserfiche.repository.api.clients;

import com.laserfiche.repository.api.clients.impl.model.ODataValueOfBoolean;
import com.laserfiche.repository.api.clients.impl.model.ODataValueOfDateTime;
import com.laserfiche.repository.api.clients.params.ParametersForCreateServerSession;
import com.laserfiche.repository.api.clients.params.ParametersForInvalidateServerSession;
import com.laserfiche.repository.api.clients.params.ParametersForRefreshServerSession;

/**
 * The Laserfiche Repository ServerSession API client.
 */
public 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.
     *
     * @param parameters An object of type {@link ParametersForInvalidateServerSession} which encapsulates the parameters of {@link #invalidateServerSession invalidateServerSession} method.
     * @return {@link ODataValueOfBoolean} The return value
     */
    ODataValueOfBoolean invalidateServerSession(ParametersForInvalidateServerSession parameters);

    /**
     * - Deprecated. This function is a no-op, always returns 200.
     * - Only available in Laserfiche Cloud.
     *
     * @param parameters An object of type {@link ParametersForCreateServerSession} which encapsulates the parameters of {@link #createServerSession createServerSession} method.
     * @return {@link ODataValueOfBoolean} The return value
     */
    ODataValueOfBoolean createServerSession(ParametersForCreateServerSession parameters);

    /**
     * - 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.
     *
     * @param parameters An object of type {@link ParametersForRefreshServerSession} which encapsulates the parameters of {@link #refreshServerSession refreshServerSession} method.
     * @return {@link ODataValueOfDateTime} The return value
     */
    ODataValueOfDateTime refreshServerSession(ParametersForRefreshServerSession parameters);
}