...
Приложения хранят REST URL web-сервера, с которым осуществляется интеграция. Кроме того приложения хранят другие настройки и данные.
App
Поле | Описание |
|---|---|
name | Название приложения. |
appKey | Уникальный идентификатор, который будет использоваться при коннекте с этим приложением со стороны клиента. |
url | REST URL для интеграции с Web-сервером по WCS RESTful API. |
owner | Пользователь которому принадлежит приложение |
mainClass | Основной класс для прямых вызовов. Для глубокой интеграции и server-side разработчиков. |
callbackClass | Основной класс для обратных вызовов. Для глубокой интеграции и server-side разработчиков. |
restUsername | Имя пользователя для HTTP аутентификации REST. |
restPassword | Пароль пользователя для HTTP аутентификации REST. |
...
- show apps
- add app
- update app
- remove app
Команда show apps
Используется для вывода существующих приложений в системе. Полный список приложений выведется только если пользователь вызывающий комманду принадлежит к супер группе. В противном случае пользователю будет показан список содержащий только принадлежащие ему приложения.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
show apps show apps -d |
Команда add app
Используется для добавления нового приложения в систему. По умолчанию новое приложение будет принадлежать пользователю который его создал. Если пользователь создающий приложение принадлежит к супер группе он может указать другого пользователя в качестве владельца приложения.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
add app MyApp myNewUniqueKey "http://localhost/my_app" add app -u rest_http_user -p rest_password MyApp2 myNewKey2 "http://localhost/my_app2" add app -o alice MyApp3 myNewKey3 "http://localhost/my_app3" |
Команда update app
Используется для изменения существующего приложения в системе. Пользователь может изменить только свои приложения. Если пользователь состоит в супер группе он может менять любые приложения. Только пользователь из супер группы может изменить владельца приложения.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
update app -k newAppKey -u new_rest_user -p new_rest_password MyApp update app -o admin MyApp update app -l "http://10.10.10.10/app" MyApp |
Команда remove app
Используется для удаления приложения. Приложение может удалить только пользователь которому оно принадлежит или пользователь состоящий в супер группе. Параметры:
<app name> имя приложения, обязательный параметр
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
remove app MyApp |
REST Methods
Для каждого приложения можно перечислить методы, которые будут вызываться у Web-сервера по REST/HTTP.
Полный список методов доступен по команде:
...
Если же метод не добавлен в приложение, REST запроса Web-серверу не последует. Например при коннекте нового пользователя не будет обращения к REST URL http://localhost/ConnectionStatusEvent.
Команда show app-rest-methods
Используется для вывода активных методов приложения.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
show app-rest-methods MyApp |
Команда add app-rest-method
Используется для добавления метода к приложению. Добавлять методы к приложению может только пользователь которому принадлежит приложение, либо пользователь который состоит в супер группе.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
add app-rest-method MyApp ConnectionStatusEvent add app-rest-method -a MyApp |
Команда remove app-rest-method
Используется для исключения метода из приложения. Исключить методы может только пользователь которому принадлежит приложение, либо пользователь который состоит в супер группе.
...