org.wildfly.clustering.web.session.Session Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-clustering-web-spi Show documentation

A set of SPIs for implementing a container-independent distributable HTTP session manager and single sign-on manager for use by a servlet container.

There is a newer version: 33.0.2.Final

Show newest version

/*
 * Copyright The WildFly Authors
 * SPDX-License-Identifier: Apache-2.0
 */
package org.wildfly.clustering.web.session;

/**
 * Represents a web session.
 * @author Paul Ferraro
 */
public interface Session extends ImmutableSession, AutoCloseable {
    /**
     * {@inheritDoc}
     */
    @Override
    SessionMetaData getMetaData();

    /**
     * Invalidates this session.
     * @throws IllegalStateException if this session was already invalidated.
     */
    void invalidate();

    /**
     * {@inheritDoc}
     */
    @Override
    SessionAttributes getAttributes();

    /**
     * Indicates that the application thread is finished with this session.
     * This method is intended to be invoked within the context of a batch.
     */
    @Override
    void close();

    /**
     * Returns the local context of this session.
     * The local context is *not* replicated to other nodes in the cluster.
     * @return a local context
     */
    L getLocalContext();
}