/*
 * This software is distributed under following license based on modified BSD
 * style license.
 * ----------------------------------------------------------------------
 * 
 * Copyright 2009 The Nimbus2 Project. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE NIMBUS PROJECT ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
 * NO EVENT SHALL THE NIMBUS PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of the Nimbus2 Project.
 */
package jp.ossc.nimbus.service.websocket;

/**
 * WebSocketのアプリケーションレベルの認証を行うインタフェース。<p>
 * WebSocketを使用する場合、通常、Web画面の初期表示を行うリクエスト/リプライ型の機能が必要で、
 * その機能を使用するのに、認証が必要ならば、リクエスト/リプライ型の認証が存在するべきである。<br>
 * WebSocketの接続は、リクエスト/リプライ型の認証の後に行う事を想定し、リクエスト/リプライ型認証で
 * 認証されているユーザからの接続であるかを確認する。<br>
 *
 * @author M.Takata
 */
public interface Authenticator{
    
    /**
     * ログインする。<p>
     *
     * @param id ユーザを特定するID
     * @param ticket 認証されたユーザのみが知るチケット情報
     * @return ログインに成功した場合、true
     * @exception AuthenticateException ログイン処理中に例外が発生した場合
     */
    public boolean login(String id, String ticket) throws AuthenticateException;
    
    /**
     * ログアウトする。<p>
     *
     * @param id ユーザを特定するID
     * @param isForce 強制、異常終了の場合は、true
     * @exception AuthenticateException ログアウト処理中に例外が発生した場合
     */
    public void logout(String id, boolean isForce) throws AuthenticateException;
}
