001/*
002 * ============================================================================
003 * Copyright © 2002-2023 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 *
007 * Licensed to the public under the agreements of the GNU Lesser General Public
008 * License, version 3.0 (the "License"). You may obtain a copy of the License at
009 *
010 *      http://www.gnu.org/licenses/lgpl.html
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
014 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
015 * License for the specific language governing permissions and limitations
016 * under the License.
017 */
018
019package org.tquadrat.foundation.config;
020
021import static org.apiguardian.api.API.Status.STABLE;
022import static org.tquadrat.foundation.config.SpecialPropertyType.CONFIG_PROPERTY_SESSION;
023
024import org.apiguardian.api.API;
025import org.tquadrat.foundation.annotation.ClassVersion;
026
027/**
028 *  The interface for a configuration bean that allows multiple instances
029 *  ("Sessions").
030 *
031 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
032 *  @version $Id: SessionBeanSpec.java 1061 2023-09-25 16:32:43Z tquadrat $
033 *  @since 0.1.0
034 *
035 *  @UMLGraph.link
036 */
037@ClassVersion( sourceVersion = "$Id: SessionBeanSpec.java 1061 2023-09-25 16:32:43Z tquadrat $" )
038@API( status = STABLE, since = "0.1.0" )
039public interface SessionBeanSpec extends ConfigBeanSpec
040{
041        /*---------*\
042    ====** Methods **==========================================================
043        \*---------*/
044    /**
045     *  Returns the session key.
046     *
047     *  @return The session key.
048     */
049    @SpecialProperty( CONFIG_PROPERTY_SESSION)
050    public String getSessionKey();
051}
052//  interface SessionBeanSpec
053
054/*
055 *  End of File
056 */