/*
 * 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.context;

import java.util.Map;
import java.util.Set;

/**
 * 共有コンテキスト。<p>
 *
 * @author M.Takata
 */
public interface SharedContext<K> extends Context<K, Object>{
    
    /**
     * 指定されたキーのロックを獲得する。<p>
     *
     * @param key キー
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public void lock(K key) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * 指定されたキーのロックを獲得する。<p>
     *
     * @param key キー
     * @param timeout タイムアウト[ms]
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public void lock(K key, long timeout) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * 指定されたキーのロックを開放する。<p>
     *
     * @param key キー
     * @return ロック開放できた場合は、true
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     */
    public boolean unlock(K key) throws SharedContextSendException;
    
    /**
     * 指定されたキーのロックを開放する。<p>
     *
     * @param key キー
     * @param force 強制フラグ
     * @return ロック開放できた場合は、true
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     */
    public boolean unlock(K key, boolean force) throws SharedContextSendException;
    
    /**
     * 指定されたキーのロックを保有しているノードのIDを取得する。<p>
     *
     * @param key キー
     * @return ロックを保有しているノードのID
     */
    public Object getLockOwner(K key);
    
    /**
     * 指定したキーで、指定した値を追加する。<p>
     *
     * @param key キー
     * @param value 値
     * @param timeout タイムアウト[ms]
     * @return 古い値
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public Object put(K key, Object value, long timeout) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * 指定したキーで、指定した値を非同期に追加する。<p>
     *
     * @param key キー
     * @param value 値
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     */
    public void putAsynch(K key, Object value) throws SharedContextSendException;
    
    /**
     * 指定したキーで、指定した差分を更新する。<p>
     *
     * @param key キー
     * @param diff 差分
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     */
    public void update(K key, SharedContextValueDifference diff) throws SharedContextSendException;
    
    /**
     * 指定したキーで、指定した差分を更新する。<p>
     *
     * @param key キー
     * @param diff 差分
     * @param timeout タイムアウト[ms]
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public void update(K key, SharedContextValueDifference diff, long timeout) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * 指定したキーで、指定した差分で非同期に更新する。<p>
     *
     * @param key キー
     * @param diff 差分
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     */
    public void updateAsynch(K key, SharedContextValueDifference diff) throws SharedContextSendException;
    
    /**
     * 指定したマップを追加する。<p>
     *
     * @param t マップ
     * @param timeout タイムアウト[ms]
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public void putAll(Map<? extends K, ? extends Object> t, long timeout) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * 指定したマップを非同期で追加する。<p>
     *
     * @param t マップ
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     */
    public void putAllAsynch(Map<? extends K, ? extends Object> t) throws SharedContextSendException;
    
    /**
     * 指定したキーの値を取得する。<p>
     *
     * @param key キー
     * @param timeout タイムアウト[ms]
     * @return 値
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public Object get(Object key, long timeout) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * 指定したキーを削除する。<p>
     *
     * @param key キー
     * @param timeout タイムアウト[ms]
     * @return 削除した値
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public Object remove(Object key, long timeout) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * 指定したキーを非同期で削除する。<p>
     *
     * @param key キー
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     */
    public void removeAsynch(Object key) throws SharedContextSendException;
    
    /**
     * 全て削除する。<p>
     *
     * @param timeout タイムアウト[ms]
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public void clear(long timeout) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * 全て非同期で削除する。<p>
     *
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     */
    public void clearAsynch() throws SharedContextSendException;
    
    /**
     * キーの集合を取得する。<p>
     *
     * @param timeout タイムアウト[ms]
     * @return キーの集合
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public Set<K> keySet(long timeout) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * 登録されているキーの件数を取得する。<p>
     *
     * @param timeout タイムアウト[ms]
     * @return キーの件数
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public int size(long timeout) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * 指定されたキーが登録されているかを判定する。<p>
     *
     * @param key キー
     * @param timeout タイムアウト[ms]
     * @return 登録されている場合true
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public boolean containsKey(Object key, long timeout) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * 指定された値が登録されているかを判定する。<p>
     *
     * @param value 値
     * @param timeout タイムアウト[ms]
     * @return 登録されている場合true
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public boolean containsValue(Object value, long timeout) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * コンテキスト同期を行う。<p>
     * クライアントモードの場合は、ローカルのコンテキストをクリアする。また、サーバモードで主ノードの場合は、全てのノードに同期命令を出す。<br>
     *
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public void synchronize() throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * コンテキスト同期を行う。<p>
     * クライアントモードの場合は、ローカルのコンテキストをクリアする。また、サーバモードで主ノードの場合は、全てのノードに同期命令を出す。<br>
     *
     * @param timeout タイムアウト
     * @exception SharedContextSendException 分散サーバへのメッセージ送信に失敗した場合
     * @exception SharedContextTimeoutException 分散サーバからの応答待ちでタイムアウトした場合
     */
    public void synchronize(long timeout) throws SharedContextSendException, SharedContextTimeoutException;
    
    /**
     * クライアント/サーバモードを判定する。<p>
     *
     * @return trueの場合、クライアントモード
     */
    public boolean isClient();
    
    /**
     * 主ノードかどうかを判定する。<p>
     *
     * @return 主ノードの場合true
     */
    public boolean isMain();
    
    /**
     * ノードIDを取得する。<p>
     *
     * @return ノードID
     */
    public Object getId();
    
    /**
     * 主ノードのノードIDを取得する。<p>
     *
     * @return ノードID
     */
    public Object getMainId();
    
    /**
     * 共有コンテキスト更新リスナーを登録する。<p>
     *
     * @param listener 共有コンテキスト更新リスナー
     */
    public void addSharedContextUpdateListener(SharedContextUpdateListener<K> listener);
    
    /**
     * 共有コンテキスト更新リスナーを削除する。<p>
     *
     * @param listener 共有コンテキスト更新リスナー
     */
    public void removeSharedContextUpdateListener(SharedContextUpdateListener<K> listener);
}