com.canoo.dolphin.server.DolphinSession Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dolphin-platform-server Show documentation

The Dolphin Platform is a framework that implements the presentation model pattern and provides amodern way to create enterprise applications. The Platform provides several client implementations that all canbe used in combination with a general sever API.

There is a newer version: 1.0.0.CR5

Show newest version

/*
 * Copyright 2015-2017 Canoo Engineering AG.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.canoo.dolphin.server;

import java.util.Set;

/**
 * Defines a Dolphin Platform Session. For each client (each client context instance) one {@link DolphinSession}
 * will be created on the server.
 */
public interface DolphinSession {

    /**
     * Binds the given object to this Dolphin Platform session, using the given name.
     * @param name the name
     * @param value the object
     */
    void setAttribute(String name, Object value);

    /**
     * Returns the object that is bound to this Dolphin Platform session with the given name or null.
     * @param name the name
     * @param  type of the object
     * @return the object or null
     */
     T getAttribute(String name);

    /**
     * Removes the object bound with the given name from
     * this Dolphin Platform session.
     * @param name the name
     */
    void removeAttribute(String name);

    /**
     * Returns a unmodifiable Set of all attribute names that defines objects that are bound to this session.
     * @return the set
     */
    Set getAttributeNames();

    /**
     * Invalidates the Dolphin Platform session.
     */
    void invalidate();

    /**
     * Returns the unique id of this Dolphin Platform session.
     * @return the id
     */
    String getId();

    /**
     * Provides a {@link ClientSessionExecutor} that can be used to access the client session from a background thread.
     * @return
     */
    ClientSessionExecutor createBackgroundRunner();
}