Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »


Приложения хранят REST URL web-сервера, с которым осуществляется интеграция. Кроме того приложения хранят другие настройки и данные.

Apps

Поле

Описание

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

Используется для вывода существующих приложений в системе. Полный список приложений выведется только если пользователь вызывающий комманду принадлежит к супер группе. В противном случае пользователю будет показан список содержащий только принадлежащие ему приложения.

Параметры:
[-d | --detail] включить детализированный вывод

Пример:

show apps
show apps -d

Команда add app

Используется для добавления нового приложения в систему. По умолчанию новое приложение будет принадлежать пользователю который его создал. Если пользователь создающий приложение принадлежит к супер группе он может указать другого пользователя в качестве владельца приложения.

Параметры:
<app name> имя приложения, обязательный параметр
<app key> уникальный ключ приложения, обязательный параметр
<app url> REST URL для интеграции с Web-сервером по WCS RESTful API, обязательный параметр
[-m | --m-class] основной класс для прямых вызовов, необязательный параметр
[-c | --c-class] основной класс для обратных вызовов, необязательный параметр
[-u | --u-rest] имя пользователя для HTTP аутентификации, необязательный параметр
[-p | --p-rest] пароль пользователя для HTTP аутентификации, необязательный параметр
[-o | --owner] пользователь которому должно принадлежать приложение, необязательный параметр

Пример:

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

Используется для изменения существующего приложения в системе. Пользователь может изменить только свои приложения. Если пользователь состоит в супер группе он может менять любые приложения. Только пользователь из супер группы может изменить владельца приложения.

Параметры:
<app name> имя приложения, обязательный параметр
[-k | --key] уникальный ключ приложения
[-l | --url] REST URL для интеграции с Web-сервером по WCS RESTful API
[-m | --m-class] основной класс для прямых вызовов
[-c | --c-class] основной класс для обратных вызовов
[-u | --u-rest] имя пользователя для HTTP аутентификации
[-p | --p-rest] пароль пользователя для HTTP аутентификации
[-o | --owner] пользователь которому должно принадлежать приложение

Пример:

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> имя приложения, обязательный параметр

Пример:

remove app MyApp

REST Methods

Для каждого приложения можно перечислить методы, которые будут вызываться у Web-сервера по REST/HTTP.
Полный список методов доступен по команде:

show rest-methods


Для включения и исключения REST-методов из приложения используются команды:

  • show app-rest-methods
  • remove app-rest-method
  • add app-rest-method

Если метод добавлен в приложение, он будет задействован в интеграции и будет вызываться каждый раз, когда этого требует WCS сервер.
Например, если добавлен метод ConnectionStatusEvent, то WCS будет вызывать REST URL http://localhost/ConnectionStatusEvent каждый раз при коннекте нового пользователя и передавать Web-серверу необходимые данные. Для более подробного описания работы REST API, см. документацию Web Call Server - Call Flow.

Если же метод не добавлен в приложение, REST запроса Web-серверу не последует. Например при коннекте нового пользователя не будет обращения к REST URL http://localhost/ConnectionStatusEvent.

Команда show app-rest-methods

Используется для вывода активных методов приложения.

Параметры:
<app_name> имя приложения, обязательный параметр

Пример:

show app-rest-methods MyApp

Команда add app-rest-method

Используется для добавления метода к приложению. Добавлять методы к приложению может только пользователь которому принадлежит приложение, либо пользователь который состоит в супер группе.

Параметры:
<app name> имя приложения, обязательный параметр
<rest method> имя метода (с вывода команды show app-rest-methods), является обязательный если не указан ключ -а
[-a | --all] добавить все доступные методы к приложению

Пример:

add app-rest-method MyApp ConnectionStatusEvent
add app-rest-method -a MyApp

Команда remove app-rest-method

Используется для исключения метода из приложения. Исключить методы может только пользователь которому принадлежит приложение, либо пользователь который состоит в супер группе.

Параметры:
<app name> имя приложения, обязательный параметр
<rest method> имя метода (с вывода команды show app-rest-methods), является обязательным если не указан ключ -а
[-a | --all] исключить все методы добавленные к приложению

Пример:

remove app-rest-method MyApp ConnectionStatusEvent
remove app-rest-method -a MyApp

  • No labels