Название

Тип

Описание

channel

String

Обязательный. Название канала веб-сокета. Он не может быть выражением EL и может содержать только буквенно-цифровые символы, дефисы, подчеркивания и точки. Все открытые веб-сокеты с одним и тем же именем канала получат одно и то же push-уведомление от сервера.

id

String

Необязательный. Идентификатор компонента UIWebSocket, который будет создан.

scope

String

Необязательный. Область применения канала веб-сокета. Не может быть выражением EL. Допустимые значения (без учёта регистра): application, session и view.

Когда значение равно application, все каналы с одинаковым именем в приложении получают одно и то же push-сообщение. Когда значение равно session, только каналы с одинаковым именем в текущей сессии пользователя получают одно и то же push-сообщение. Когда значением является view, только канал в текущем представлении получает push-сообщение.

Область видимости по умолчанию — application. Если указан атрибут user, то областью по умолчанию является session.

user

Serializable

Необязательный. Идентификатор пользователя канала веб-сокета, чтобы можно было отправлять push-сообщения, ориентированные на пользователя. Он должен реализовывать Serializable и предпочтительно иметь небольшой объём памяти.

Подсказка: используйте #{request.remoteUser} или #{someLoggedInUser.id}.

Все открытые веб-сокеты на одном канале и пользователь получат одно и то же push-сообщение с сервера.

onopen

String

Необязательный. Функция обработчика событий JavaScript, которая вызывается при открытии веб-сокета. Функция вызывается с одним аргументом: именем канала.

onmessage

String

Необязательный. Функция обработчика событий JavaScript, которая вызывается при получении push-сообщения от сервера. Функция вызывается с тремя аргументами: push-сообщением, именем канала и объектом MessageEvent.

onclose

String

Необязательный. Функция обработчика событий JavaScript, которая вызывается при закрытии веб-сокета. Функция вызывается с тремя аргументами: кодом причины закрытия, именем канала и CloseEvent.

Обратите внимание, что функция будет вызываться также и при ошибках. Если произошла ошибка, вы можете проверить код причины закрытия и какой код был задан (например, когда код не 1000).

connected

Boolean

Необязательный. Указывает, нужно ли автоматически повторно подключать веб-сокет. По умолчанию true. Интерпретируется как инструкция JavaScript для открытия или закрытия push-соединения веб-сокета.

Этот атрибут неявным образом вычисляется при каждом запросе ajax слушателем PreRenderViewEvent в UIViewRoot. Вы также можете явно установить для него значение false, а затем вручную управлять им в JavaScript, используя jsf.push.open(clientId) и jsf.push.close(clientId).

rendered

Boolean

Необязательный. Указывает, следует ли отображать сценарии веб-сокета. По умолчанию true.

Этот атрибут неявным образом вычисляется при каждом запросе ajax слушателем PreRenderViewEvent в UIViewRoot. Если значение изменится на false, когда веб-сокет уже открыт, то веб-сокет будет неявно закрыт.

binding

UIComponent

Необязательный. Выражение привязки значения к свойству базового компонента, привязанному к объекту компонента для UIComponent, созданного этим тегом.