org.wildfly.clustering.web.session.ImmutableSession 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 an immutable view of a web session.
 * @author Paul Ferraro
 */
public interface ImmutableSession {
    /**
     * Specifies this session's unique identifier.
     * @return a unique identifier for this session.
     */
    String getId();

    /**
     * Indicates whether or not this session is valid.
     * @return true, if this session is valid, false otherwise
     */
    boolean isValid();

    /**
     * Returns this session's meta data.
     * @return this session's meta data
     * @throws IllegalStateException if this session is invalid
     */
    ImmutableSessionMetaData getMetaData();

    /**
     * Returns this session's attributes.
     * @return this session's attributes
     * @throws IllegalStateException if this session is invalid
     */
    ImmutableSessionAttributes getAttributes();
}