001/*
002 * GWTEventService
003 * Copyright (c) 2011 and beyond, strawbill UG (haftungsbeschr?nkt)
004 *
005 * This is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU Lesser General Public License as
007 * published by the Free Software Foundation; either version 3 of
008 * the License, or (at your option) any later version.
009 * Other licensing for GWTEventService may also be possible on request.
010 * Please view the license.txt of the project for more information.
011 *
012 * This software is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * You should have received a copy of the GNU Lesser General Public
018 * License along with this software; if not, write to the Free
019 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021 */
022package de.novanic.eventservice.service.connection.id;
023
024import javax.servlet.http.HttpServletRequest;
025
026/**
027 * A {@link de.novanic.eventservice.service.connection.id.ConnectionIdGenerator} generates unique ids which are used to
028 * identify the connected clients / users.
029 *
030 * @author sstrohschein
031 *         <br>Date: 28.03.2010
032 *         <br>Time: 23:34:01
033 */
034public interface ConnectionIdGenerator
035{
036    /**
037     * Generates a new connection / client id.
038     * @param aRequest request from the client
039     * @return unique connection / client id
040     */
041    String generateConnectionId(HttpServletRequest aRequest);
042
043    /**
044     * Returns the previous generated connection / client id
045     * (see {@link de.novanic.eventservice.service.connection.id.ConnectionIdGenerator#generateConnectionId(javax.servlet.http.HttpServletRequest)})
046     * without generating a new connection / client id.
047     * @see de.novanic.eventservice.service.connection.id.ConnectionIdGenerator#generateConnectionId(javax.servlet.http.HttpServletRequest)
048     * @param aRequest request
049     * @return the previous generated connection / client id for the specific client
050     */
051    String getConnectionId(HttpServletRequest aRequest);
052}