|
|||||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object | +--jp.wda.gpss.GeneralSocklet
[ OProject GPSS for FlashMX ] FlashMX用汎用ソケットサーバ
最も基本的なSocklet基底クラス
Sockletを作成するには、このクラスから派生させるのが、最も基本的な方法です。
このクラスから派生して作成するSockletクラスでは、
まずSockletの初期化ルーチンを記述するために、以下のメソッドのどちらか一つをオーバーライドしてください。
初期化の必要が無ければ、オーバーライドする必要はありません。
protected void init()次にjp.wda.gpss.Sockletインターフェースの、以下のメソッドを必ずオーバーライドする必要があります。
protected void init(List linkedSocklets)
public boolean doCommand(SocketProcessor client, String command)
public boolean checkConnection(SocketProcessor client)各メソッドについては、jp.wda.gpss.Sockletのドキュメントを参照してください。
public void preRemoveClient(SocketProcessor client)
public void afterDeployedLinks(Map linkedSocklets)
public void destroy()
public boolean allowAccessFromOtherSocklet(Socklet from)メソッドをオーバーライドし、連携しようとしてきたSockletを検査してください。
コンストラクタの概要 | |
GeneralSocklet()
|
メソッドの概要 | |
void |
addClient(SocketProcessor client)
指定したクライアントを、このSockletの接続中クライアント一覧に追加します。 |
void |
afterDeployedLinks(java.util.Map linkedSocklets)
このメソッドはinit(SockletDeployInfo info, List links, Progress progress)にて、 linksオブジェクトに設定された追加配備Sockletを配備し終えた後、サーバにより起動時に1回だけ呼ばれます。 |
boolean |
allowAccessFromOtherSocklet(Socklet from)
他のSockletからのアクセスを許可するかどうかを確認します。 |
boolean |
checkConnection(SocketProcessor client)
接続用初期コマンド受信後、クライアントの検査を行うためのメソッド。 |
boolean |
containsAttributeKey(java.lang.Object key)
指定された属性名のSocklet固有属性が設定されているかを確認します。 |
boolean |
containsClient(SocketProcessor client)
指定したクライアントが、現在このSockletの接続中クライアント一覧に存在するか確認します。 |
SockletDeployInfo |
copyInfo(java.lang.String appname,
java.lang.String classname)
指定された配備名を持つ、新しいSocklet配備情報オブジェクトを作成します。 |
int |
countClients()
現在接続中のクライアント数を数えます。 |
java.lang.String |
deployedBy()
このSockletを配備したSocklet名を取得します。 |
void |
deployedBy(ExecutableBase server,
java.lang.String name)
このSockletを配備したSocklet名を設定します。 |
void |
destroy()
Sockletがサービスを停止する際に、待受けメインサーバによって呼び出されます。 |
void |
disconnectAllClients(java.lang.String message)
このSockletに接続中の全クライアントを切断します。 |
java.util.List |
getAllClients()
このSockletに接続中の全てのクライアント一覧を、リストとして取得します。 |
java.lang.Object |
getAttribute(java.lang.Object key)
このSockletに設定されている、指定された名前のSocklet固有属性値を取得します。 |
boolean |
getAttributeBoolean(java.lang.Object key)
このSockletに設定されている、指定された名前のSocklet固有属性値を真偽値として取得します。 |
double |
getAttributeDouble(java.lang.Object key)
このSockletに設定されている、指定された名前の固有属性値を実数値として取得します。 |
int |
getAttributeInt(java.lang.Object key)
このSockletに設定されている、指定された名前のSocklet固有属性値を整数値として取得します。 |
java.util.Set |
getAttributeKeys()
Socklet固有属性に格納されている属性名一覧のSetビューを取得します。 |
long |
getAttributeLong(java.lang.Object key)
このSockletに設定されている、指定された名前のSocklet固有属性値を長整数値として取得します。 |
java.util.Set |
getAttributes()
Socklet固有属性に格納されている全ての属性一覧のSetビューを取得します。 |
java.util.List |
getClients(Finder finder)
このSockletに接続中のクライアント一覧のうち、 指定された条件を有するクライアントを一覧を、リストとして取得します。 |
java.util.List |
getClients(java.lang.String condition)
このSockletに接続中のクライアント一覧のうち、 指定された条件を有するクライアントを一覧を、リストとして取得します。 |
java.lang.String |
getInitParam(java.lang.String key)
このSockletに設定されている、指定された名前のSocklet初期化パラメータ値を1つ取得します。 |
java.util.List |
getInitParamKeys()
このSockletに設定されている、すべてのSocklet初期化パラメータの名前一覧をリストとして取得します。 |
java.util.List |
getInitParams()
このSockletに設定されている、すべてのSocklet初期化パラメータ値一覧をリストとして取得します。 |
java.util.List |
getInitParams(java.lang.String key)
このSockletに設定されている、指定された名前のSocklet初期化パラメータ値一覧をリストとして取得します。 |
ExecutableBase |
getMain()
推奨されていません。 |
java.lang.String |
getName()
このSockletの配備名を取得します。 |
Socklet |
getOtherSocklet(java.lang.String appname)
Socklet配備名を指定して、現在このサーバに配備されている、別のSockletを取得します。 |
int |
getTimeout()
タイムアウト時間(ミリ秒単位)を取得します。 |
boolean |
hasInitParam(java.lang.String key)
指定された初期化パラメタ名の値が設定されているかを確認します。 |
void |
init(SockletDeployInfo info,
java.util.List links,
Progress progress)
このSockletを初期化します。 |
void |
log(java.lang.Object message)
Socklet指定ログファイルか、それが登録されていない場合はシステムログファイルに、 情報ログを出力します。 |
void |
log(java.lang.Object message,
org.apache.log4j.Priority priority)
Socklet指定ログファイルか、それが登録されていない場合はシステムログファイルに、 指定された種類のログを出力します。 |
void |
log(java.lang.Object message,
org.apache.log4j.Priority priority,
java.lang.Throwable throwable)
Socklet指定ログファイルか、それが登録されていない場合はシステムログファイルに、 指定された種類のログを出力します。 |
void |
log(java.lang.Object message,
java.lang.Throwable throwable)
Socklet指定ログファイルか、それが登録されていない場合はシステムログファイルに、 エラーログを出力します。 |
void |
memo(java.lang.String logger,
java.lang.Object message)
ログを出力します。 |
void |
memo(java.lang.String logger,
java.lang.Object message,
org.apache.log4j.Priority priority)
ログを出力します。 |
void |
memo(java.lang.String logger,
java.lang.Object message,
org.apache.log4j.Priority priority,
java.lang.Throwable t)
ログを出力します。 |
void |
memo(java.lang.String logger,
java.lang.Object message,
java.lang.Throwable t)
ログを出力します。 |
Finder |
preCreateFinder(java.lang.String condition)
クライアント絞込条件指定オブジェクトを構築します。 |
void |
preRemoveClient(SocketProcessor client)
クライアント削除前に呼び出されるメソッド。 |
java.lang.Object |
removeAttribute(java.lang.Object key)
指定された属性名のSocklet固有属性を削除します。 |
void |
removeClient(SocketProcessor client)
指定したクライアントを、このSockletの接続中クライアント一覧から削除します。 |
void |
sendToAllClients(java.lang.String message)
このSockletに接続中の全てのクライアントに向けて、メッセージを送信します。 |
void |
sendToClients(java.lang.String message,
Finder finder)
このSockletに接続中のクライアントのうち、特定の条件を有するクライアントのみに向けて、メッセージを送信します。 |
void |
sendToClients(java.lang.String message,
java.lang.String condition)
このSockletに接続中のクライアントのうち、特定の条件を有するクライアントのみに向けて、メッセージを送信します。 |
void |
setAttribute(java.lang.Object key,
boolean value)
このSockletに、指定された名前のSocklet固有属性値を真偽値として設定します |
void |
setAttribute(java.lang.Object key,
double value)
このSockletに、指定された名前の固有属性値を実数値として設定します |
void |
setAttribute(java.lang.Object key,
int value)
このSockletに、指定された名前のSocklet固有属性値を設定します |
void |
setAttribute(java.lang.Object key,
long value)
このSockletに、指定された名前のSocklet固有属性値を長整数値として設定します |
void |
setAttribute(java.lang.Object key,
java.lang.Object value)
このSockletに、指定された名前のSocklet固有属性値を設定します |
void |
setMain(ExecutableBase server)
メインサーバを設定します。 |
void |
setTimeout(int timeout)
タイムアウト時間(ミリ秒単位)を設定します。 |
クラス java.lang.Object から継承したメソッド |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
インタフェース jp.wda.gpss.Socklet から継承したメソッド |
doCommand |
コンストラクタの詳細 |
public GeneralSocklet()
メソッドの詳細 |
public final ExecutableBase getMain()
public final void setMain(ExecutableBase server)
server
- ソケット待受けメインサーバpublic final java.lang.String deployedBy()
Socklet
内の deployedBy
Socklet.deployedBy()
public final void deployedBy(ExecutableBase server, java.lang.String name)
Socklet
内の deployedBy
Socklet.deployedBy(ExecutableBase, String)
public final java.lang.String getName()
Socklet
内の getName
Socklet.getName()
public final int getTimeout()
Socklet
内の getTimeout
Socklet.getTimeout()
public final void setTimeout(int timeout)
Socklet
内の setTimeout
timeout
- 設定するタイムアウト時間(ミリ秒単位)
Socklet.setTimeout(int)
public final java.lang.String getInitParam(java.lang.String key)
InitParamContainer
内の getInitParam
key
- 取得したいパラメータの名前
getInitParams(String key)
,
getInitParams()
,
InitParamContainer.getInitParam(String)
public final java.util.List getInitParams(java.lang.String key)
InitParamContainer
内の getInitParams
key
- 取得したいパラメータの名前
getInitParam(String key)
,
getInitParams()
,
InitParamContainer.getInitParam(String)
public java.util.List getInitParams()
InitParamContainer
内の getInitParams
getInitParams(String key)
,
getInitParam(String key)
,
InitParamContainer.getInitParams()
public java.util.List getInitParamKeys()
InitParamContainer
内の getInitParamKeys
InitParamContainer.getInitParamKeys()
public boolean hasInitParam(java.lang.String key)
InitParamContainer
内の hasInitParam
key
- 初期化パラメタ名InitParamContainer.hasInitParam(String)
public final void setAttribute(java.lang.Object key, java.lang.Object value)
AttributeContainer
内の setAttribute
key
- Socklet固有属性名value
- Socklet固有属性値AttributeContainer.setAttribute(Object, Object)
public final java.lang.Object getAttribute(java.lang.Object key)
AttributeContainer
内の getAttribute
key
- Socklet固有属性名
AttributeContainer.getAttribute(Object)
public java.util.Set getAttributes()
AttributeContainer
内の getAttributes
AttributeContainer.getAttributes()
public boolean containsAttributeKey(java.lang.Object key)
AttributeContainer
内の containsAttributeKey
key
- Socklet固有属性名AttributeContainer.containsAttributeKey(Object)
public java.util.Set getAttributeKeys()
AttributeContainer
内の getAttributeKeys
AttributeContainer.getAttributeKeys()
public java.lang.Object removeAttribute(java.lang.Object key)
AttributeContainer
内の removeAttribute
key
- Socklet固有属性名AttributeContainer.removeAttribute(Object)
public final void setAttribute(java.lang.Object key, int value)
AttributeContainer
内の setAttribute
key
- Socklet固有属性名value
- Socklet固有属性整数値AttributeContainer.setAttribute(Object, int)
public final int getAttributeInt(java.lang.Object key) throws AttributeException
AttributeContainer
内の getAttributeInt
key
- Socklet固有属性名
AttributeException
AttributeContainer.getAttributeInt(Object)
public final void setAttribute(java.lang.Object key, long value)
AttributeContainer
内の setAttribute
key
- Socklet固有属性名value
- Socklet固有属性長整数値AttributeContainer.setAttribute(Object, long)
public final long getAttributeLong(java.lang.Object key) throws AttributeException
AttributeContainer
内の getAttributeLong
key
- Socklet固有属性名
AttributeException
AttributeContainer.getAttributeLong(Object)
public final void setAttribute(java.lang.Object key, double value)
AttributeContainer
内の setAttribute
key
- Socklet固有属性名value
- Socklet固有属性実数値AttributeContainer.setAttribute(Object, double)
public final double getAttributeDouble(java.lang.Object key) throws AttributeException
AttributeContainer
内の getAttributeDouble
key
- Socklet固有属性名
AttributeException
AttributeContainer.getAttributeLong(Object)
public final void setAttribute(java.lang.Object key, boolean value)
AttributeContainer
内の setAttribute
key
- Socklet固有属性名value
- Socklet固有属性真偽値AttributeContainer.setAttribute(Object, boolean)
public final boolean getAttributeBoolean(java.lang.Object key) throws AttributeException
AttributeContainer
内の getAttributeBoolean
key
- Socklet固有属性名
AttributeException
AttributeContainer.getAttributeBoolean(Object)
public SockletDeployInfo copyInfo(java.lang.String appname, java.lang.String classname)
appname
- 配備名
public final Socklet getOtherSocklet(java.lang.String appname)
appname
- Socklet配備名
public final void sendToAllClients(java.lang.String message)
Socklet
内の sendToAllClients
message
- 送信するメッセージSocklet.sendToAllClients(String)
public final void sendToClients(java.lang.String message, Finder finder)
Socklet
内の sendToClients
message
- 送信するメッセージfinder
- 送信したいクライアント検索用オブジェクトSocketProcessorFinder.getFinder(String)
,
Socklet.sendToClients(String, Finder)
public final void sendToClients(java.lang.String message, java.lang.String condition)
Socklet
内の sendToClients
message
- 送信するメッセージcondition
- 送信したいクライアントの検索条件文SocketProcessorFinder.getFinder(String)
,
Socklet.sendToClients(String, String)
public final void addClient(SocketProcessor client)
Socklet
内の addClient
client
- 追加するクライアントSocklet.addClient(SocketProcessor)
public final void removeClient(SocketProcessor client)
Socklet
内の removeClient
client
- 削除するクライアントSocklet.removeClient(SocketProcessor)
public final int countClients()
Socklet
内の countClients
Socklet.countClients()
public final boolean containsClient(SocketProcessor client)
client
- 確認するクライアントソケット処理オブジェクト
public final java.util.List getAllClients()
public final java.util.List getClients(Finder finder)
finder
- クライアント検索条件表現オブジェクト
public final java.util.List getClients(java.lang.String condition)
condition
- クライアント検索条件文字列
SocketProcessorFinder.getFinder(String)
public final void disconnectAllClients(java.lang.String message)
Socklet
内の disconnectAllClients
message
- 閉鎖メッセージSocklet.disconnectAllClients(String)
public final Finder preCreateFinder(java.lang.String condition)
condition
- クライアント検索条件文字列
public void log(java.lang.Object message)
message
- 出力するログメッセージpublic void log(java.lang.Object message, org.apache.log4j.Priority priority)
message
- 出力するログメッセージpriority
- ログ情報種類public void log(java.lang.Object message, java.lang.Throwable throwable)
message
- 出力するログメッセージthrowable
- 発生したエラーpublic void log(java.lang.Object message, org.apache.log4j.Priority priority, java.lang.Throwable throwable)
Socklet
内の log
message
- 出力するログメッセージpriority
- ログ情報種類throwable
- 発生したエラーSocklet.log(Object, Priority, Throwable)
public void memo(java.lang.String logger, java.lang.Object message)
logger
- 出力先ロガー名message
- 出力するログメッセージProgress.log(String, Object)
public void memo(java.lang.String logger, java.lang.Object message, org.apache.log4j.Priority priority)
logger
- 出力先ロガー名message
- 出力するログメッセージpriority
- ログ情報種類Progress.log(String, Object, Priority)
public void memo(java.lang.String logger, java.lang.Object message, java.lang.Throwable t)
logger
- 出力先ロガー名message
- 出力するログメッセージProgress.log(String, Object, Throwable)
public void memo(java.lang.String logger, java.lang.Object message, org.apache.log4j.Priority priority, java.lang.Throwable t)
logger
- 出力先ロガー名message
- 出力するログメッセージpriority
- ログ情報種類Progress.log(String, Object, Priority, Throwable)
public final void init(SockletDeployInfo info, java.util.List links, Progress progress)
Socklet
内の init
info
- Socklet配備情報links
- 自動的に追加配備したいSockletのSocklet配備情報オブジェクトを設定するためのListprogress
- ソケット処理状況進捗管理オブジェクト。Socklet.init(SockletDeployInfo, List, Progress)
public void afterDeployedLinks(java.util.Map linkedSocklets)
Socklet
内の afterDeployedLinks
Socklet.afterDeployedLinks(Map)
public boolean checkConnection(SocketProcessor client)
Socklet
内の checkConnection
client
- 接続を試みているクライアント
checkConnection(SocketProcessor)
,
SocketProcessor
public void preRemoveClient(SocketProcessor client)
Socklet
内の preRemoveClient
client
- これから削除されるクライアントpreRemoveClient(SocketProcessor)
public void destroy()
Socklet
内の destroy
Socklet.destroy()
public boolean allowAccessFromOtherSocklet(Socklet from)
Socklet
内の allowAccessFromOtherSocklet
from
- アクセスを試みてきた、他のSocklet
Socklet.allowAccessFromOtherSocklet(Socklet)
|
|||||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |