io.baratine.service.Session Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
A reactive Java web server.
The newest version!
/*
 * Copyright (c) 1998-2015 Caucho Technology -- all rights reserved
 *
 * This file is part of Baratine(TM)(TM)
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Baratine is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Baratine is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Baratine; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Alex Rojkov
 */

package io.baratine.service;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Annotation Session specifies that an annotated service is a Session service, i.e.
 * that each client is designated a unique instance of a service.
 *
 * Client's instance of Session service has a unique id which can be injected into
 * a service with an @Id annotated field of type String.
 *
 * Baratine uses JSESSIONID cookie to store session id value.
 *
 * e.g.
 * 
 *  * @Session
 * public class MySession {
 *   @Id String id;
 *
 *   @Get
 *   public void get(Result<String> result) {
 *     result.ok(id);
 *   }
 * }
 * 
 * 
 */
@Documented
@Retention(RUNTIME)
@Target({TYPE})
@Service("session:")
public @interface Session
{
}