UIWebsocket (Jakarta EE Platform API)

java.lang.ObjectSE
- jakarta.faces.component.UIComponent
- - jakarta.faces.component.UIComponentBase
  - - jakarta.faces.component.UIWebsocket

実装されたすべてのインターフェース:
ClientBehaviorHolder, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListenerSE
```
public class UIWebsocket
extends UIComponentBase
implements ClientBehaviorHolder
```
<f:websocket> タグは、クライアント側で一方向（サーバーからクライアント）の Websocket ベースのプッシュ接続を開きます。これは、@Push アノテーションを介して CDI/ コンテナー管理アーティファクトに注入された PushContext インターフェースを介してサーバー側から到達できます。
デフォルトでは、rendererType プロパティを "jakarta.faces.Websocket" に設定する必要があります。この値は、setRendererType() メソッドを呼び出すことで変更できます。
詳しい使用方法については、@Push javadoc を参照してください。
導入:
2.3
関連事項:
Push

フィールドサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`COMPONENT_FAMILY` このコンポーネントの標準コンポーネントファミリ。
`static StringSE`	`COMPONENT_TYPE` このコンポーネントの標準コンポーネント型。

クラス jakarta.faces.component.UIComponent から継承されたフィールド
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
UIWebsocket()
デフォルトのプロパティ値で新しい UIWebsocket インスタンスを作成します。

コンストラクター
コンストラクターと説明
`UIWebsocket()` デフォルトのプロパティ値で新しい `UIWebsocket` インスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`StringSE`	`getChannel()` WebSocket チャネルの名前を返します。
`CollectionSE<StringSE>`	`getEventNames()` すべてのクライアント動作イベント名が受け入れ可能であることを示す、`Collection#contains()` 呼び出しで `true` を返す、null 以外の空の変更不可能な `Collection` を返します。
`StringSE`	`getFamily()` `COMPONENT_FAMILY` を返します。
`StringSE`	`getOnclose()` WebSocket が閉じられたときに呼び出される JavaScript イベントハンドラー関数を返します。
`StringSE`	`getOnmessage()` サーバーからプッシュメッセージを受信したときに呼び出される JavaScript イベントハンドラー関数を返します。
`StringSE`	`getOnopen()` WebSocket が開かれたときに呼び出される JavaScript イベントハンドラー関数を返します。
`StringSE`	`getScope()` WebSocket チャネルのスコープを返します。
`SerializableSE`	`getUser()` WebSocket チャネルのユーザー ID を返します。
`boolean`	`isConnected()` WebSocket を（自動）接続するかどうかを返します。
`void`	`setChannel(StringSE channel)` WebSocket チャネルの名前を設定します。
`void`	`setConnected(boolean connected)` WebSocket を（自動）接続するかどうかを設定します。
`void`	`setOnclose(StringSE onclose)` WebSocket が閉じられたときに呼び出される JavaScript イベントハンドラー関数を設定します。
`void`	`setOnmessage(StringSE onmessage)` サーバーからプッシュメッセージを受信したときに呼び出される JavaScript イベントハンドラー関数を設定します。
`void`	`setOnopen(StringSE onopen)` WebSocket が開かれたときに呼び出される JavaScript イベントハンドラー関数を設定します。
`void`	`setScope(StringSE scope)` WebSocket チャネルのスコープを設定します。
`void`	`setUser(SerializableSE user)` ユーザーをターゲットにしたプッシュメッセージを送信できるように、websocket チャネルのユーザー識別子を設定します。
`void`	`setValueExpression(StringSE name, ValueExpression binding)` 指定された属性またはプロパティ名がある場合は、その値の計算に使用される `ValueExpression` を設定します。

クラス jakarta.faces.component.UIComponentBase から継承されたメソッド
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

クラス jakarta.faces.component.UIComponent から継承されたメソッド
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース jakarta.faces.component.behavior.ClientBehaviorHolder から継承されたメソッド
addClientBehavior, getClientBehaviors, getDefaultEventName

- フィールドの詳細
  - COMPONENT_TYPE
```
public static final StringSE COMPONENT_TYPE
```
    このコンポーネントの標準コンポーネント型。
    関連事項:
    定数フィールド値
  - COMPONENT_FAMILY
```
public static final StringSE COMPONENT_FAMILY
```
    このコンポーネントの標準コンポーネントファミリ。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - UIWebsocket
```
public UIWebsocket()
```
    デフォルトのプロパティ値で新しい UIWebsocket インスタンスを作成します。
    例外:
    IllegalStateExceptionSE - Websocket エンドポイントが有効になっていない場合。
- メソッドの詳細
  - getFamily
```
public StringSE getFamily()
```
    COMPONENT_FAMILY を返します。
    次で指定:
    クラス UIComponent の getFamily
    戻り値:
    コンポーネントファミリ（null 以外）。
  - setValueExpression
```
public void setValueExpression(StringSE name,
                               ValueExpression binding)
```
    指定された属性またはプロパティ名がある場合は、その値の計算に使用される ValueExpression を設定します。channel または scope プロパティに ValueExpression が設定されている場合、値に関係なく、不正な引数の例外がスローされます。user プロパティに ValueExpression が設定されていて、null 以外の値が Serializable のインスタンスでない場合は、不正な引数例外をスローします。
    オーバーライド:
    クラス UIComponent の setValueExpression
    パラメーター:
    name - ValueExpression を設定する属性またはプロパティの名前
    binding - 設定する ValueExpression、または現在設定されている ValueExpression を削除する null
    例外:
    IllegalArgumentExceptionSE - name が id、parent、channel または scope のいずれかである場合、または name が user であり、null 以外の値が Serializable のインスタンスではない場合。
    NullPointerExceptionSE - name が null の場合。
  - getEventNames
```
public CollectionSE<StringSE> getEventNames()
```
    すべてのクライアント動作イベント名が受け入れ可能であることを示す、Collection#contains() 呼び出しで true を返す、null 以外の空の変更不可能な Collection を返します。
    次で指定:
    インターフェース ClientBehaviorHolder の getEventNames
    オーバーライド:
    クラス UIComponentBase の getEventNames
    戻り値:
    イベント名のコレクション。
  - getChannel
```
public StringSE getChannel()
```
    WebSocket チャネルの名前を返します。
    戻り値:
    WebSocket チャネルの名前。
  - setChannel
```
public void setChannel(StringSE channel)
```
    WebSocket チャネルの名前を設定します。これは Jakarta Expression Language 式ではなく、英数字、ハイフン、アンダースコア、ピリオドのみを含むことができます。同じチャネルで開いているすべての WebSocket は、サーバーから同じプッシュメッセージを受信します。
    パラメーター:
    channel - WebSocket チャネルの名前。
    例外:
    IllegalArgumentExceptionSE - 値が有効なチャネル名を表していない場合。
  - getScope
```
public StringSE getScope()
```
    WebSocket チャネルのスコープを返します。
    戻り値:
    WebSocket チャネルのスコープ。
  - setScope
```
public void setScope(StringSE scope)
```
    WebSocket チャネルのスコープを設定します。Jakarta Expression Language 式ではない可能性があり、許可される値は application、session、view であり、大文字と小文字は区別されません。値が application の場合、アプリケーション全体で同じ名前のすべてのチャネルが同じプッシュメッセージを受信します。値が session の場合、現在のユーザーセッションで同じ名前のチャネルのみが同じプッシュメッセージを受信します。値が view の場合、現在のビューのチャネルのみがプッシュメッセージを受信します。デフォルトのスコープは application です。user 属性が指定されている場合、デフォルトのスコープは session です。
    パラメーター:
    scope - WebSocket チャネルのスコープ。
  - getUser
```
public SerializableSE getUser()
```
    WebSocket チャネルのユーザー ID を返します。
    戻り値:
    WebSocket チャネルのユーザー ID。
  - setUser
```
public void setUser(SerializableSE user)
```
    WebSocket チャネルのユーザー識別子を設定して、ユーザーをターゲットとしたプッシュメッセージを送信できるようにします。同じチャネルとユーザーで開いているすべての WebSocket は、サーバーから同じプッシュメッセージを受信します。Serializable を実装する必要があり、メモリフットプリントが小さいことが望ましい。提案: #{request.remoteUser} または #{someLoggedInUser.id} を使用してください。
    パラメーター:
    user - WebSocket チャネルのユーザー ID。
  - getOnopen
```
public StringSE getOnopen()
```
    WebSocket が開かれたときに呼び出される JavaScript イベントハンドラー関数を返します。
    戻り値:
    WebSocket が開かれたときに呼び出される JavaScript イベントハンドラー関数。
  - setOnopen
```
public void setOnopen(StringSE onopen)
```
    WebSocket が開かれたときに呼び出される JavaScript イベントハンドラー関数を設定します。この関数は、チャネル名という 1 つの引数で呼び出されます。
    パラメーター:
    onopen - WebSocket が開かれたときに呼び出される JavaScript イベントハンドラー関数。
  - getOnmessage
```
public StringSE getOnmessage()
```
    サーバーからプッシュメッセージを受信したときに呼び出される JavaScript イベントハンドラー関数を返します。
    戻り値:
    サーバーからプッシュメッセージを受信したときに呼び出される JavaScript イベントハンドラー関数。
  - setOnmessage
```
public void setOnmessage(StringSE onmessage)
```
    サーバーからプッシュメッセージを受信したときに呼び出される JavaScript イベントハンドラー関数を設定します。この関数は、プッシュメッセージ、チャネル名、生の MessageEvent 自体の 3 つの引数で呼び出されます。
    パラメーター:
    onmessage - サーバーからプッシュメッセージを受信したときに呼び出される JavaScript イベントハンドラー関数。
  - getOnclose
```
public StringSE getOnclose()
```
    WebSocket が閉じられたときに呼び出される JavaScript イベントハンドラー関数を返します。
    戻り値:
    WebSocket が閉じられたときに呼び出される JavaScript イベントハンドラー関数。
  - setOnclose
```
public void setOnclose(StringSE onclose)
```
    WebSocket が閉じられたときに呼び出される JavaScript イベントハンドラー関数を設定します。この関数は、クローズ理由コード、チャネル名、生の CloseEvent 自体の 3 つの引数を使用して呼び出されます。これはエラー時にも呼び出され、エラーが発生したかどうか、エラーが発生した場合（つまり、コードが 1000 でない場合）にクローズ理由コードをインスペクションできることに注意してください。すべてのクローズコードの詳細なリストについては、RFC6455 セクション 7.4.1 および CloseReason.CloseCodes API も参照してください。
    パラメーター:
    onclose - WebSocket が閉じられたときに呼び出される JavaScript イベントハンドラー関数。
  - isConnected
```
public boolean isConnected()
```
    WebSocket を（自動）接続するかどうかを返します。
    戻り値:
    WebSocket を（自動）接続するかどうか。
  - setConnected
```
public void setConnected(boolean connected)
```
    WebSocket を（自動）接続するかどうかを設定します。デフォルトは true です。これは、WebSocket プッシュ接続を開くか閉じるかを JavaScript 命令として解釈します。この属性は、ajax リクエストごとに再評価されることに注意してください。明示的に false に設定してから、OmniFaces.Push.open("channelName") および OmniFaces.Push.close("channelName") によって JavaScript を手動で制御することもできます。
    パラメーター:
    connected - WebSocket を（自動）接続するかどうか。

クラス UIWebsocket

フィールドサマリー

クラス jakarta.faces.component.UIComponent から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス jakarta.faces.component.UIComponentBase から継承されたメソッド

クラス jakarta.faces.component.UIComponent から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース jakarta.faces.component.behavior.ClientBehaviorHolder から継承されたメソッド

フィールドの詳細

COMPONENT_TYPE

COMPONENT_FAMILY

コンストラクターの詳細

UIWebsocket

メソッドの詳細

getFamily

setValueExpression

getEventNames

getChannel

setChannel

getScope

setScope

getUser

setUser

getOnopen

setOnopen

getOnmessage

setOnmessage

getOnclose

setOnclose

isConnected

setConnected