kz.arta.synergy.api.rest.admin

Class DBService

java.lang.Object

kz.arta.synergy.api.rest.admin.DBService

public class DBService
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DBService()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDbVersion() Текущая версия базы данных URL: rest/api/admin/db/current_version Type: GET
java.lang.String	getMaxVersion() Максимальная версия базы данных, на которую можно обновиться URL: rest/api/admin/db/max_version Type: GET
java.lang.String	getMessages() Сообщении об выполнения обновления базы данных.
java.lang.String	getUserID()
java.lang.String	onDbUpdated() Обнуляет статическую карту с правилами, для того чтобы при последующем использовании она была перезагружена.
java.lang.String	startUpdate() Запуск обновления базы данных.
java.lang.String	updatingIsCompleted() Проверка статуса выполнения обновление базы.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DBService

public DBService()

Method Detail

getMaxVersion

public java.lang.String getMaxVersion()

Максимальная версия базы данных, на которую можно обновиться

URL: rest/api/admin/db/max_version

Type: GET

Returns:

json данные об статусе выполнения запроса и с версией базы данных
Пример возвращаемых данных метода, при успешном выполнении
{
"errorCode": 0,
"errorMessage": "Success",
"data": "270",
}


Пример возвращаемых данных метода, в случае ошибки
{
"errorCode": 13,
"errorMessage": "Ошибка исполнения",
"data": null,
}

getDbVersion

public java.lang.String getDbVersion()

Текущая версия базы данных

URL: rest/api/admin/db/current_version

Type: GET

Returns:

json данные об статусе выполнения запроса и с текущей версией базы данных
Пример возвращаемых данных метода, при успешном выполнении
{
"errorCode": 0,
"errorMessage": "Success",
"data": "263",
}


Пример возвращаемых данных метода, в случае ошибки
{
"errorCode": 13,
"errorMessage": "Ошибка исполнения",
"data": null,
}

startUpdate

public java.lang.String startUpdate()

Запуск обновления базы данных. Статус выполнения обновления можно проверить с помощью методов /rest/api/admin/db/messages или /rest/api/admin/db/updating_is_completed

Процесс обновления базы данных:

1. /rest/api/admin/db/current_version - получаем текущую версию базы
2. /rest/api/admin/db/max_version - получаем доступную версию
3. Сравниваем полученные версии, если текущая версия базы меньше чем доступное, то запускаем обновление /rest/api/admin/db/start_update
4. Периодический проверяем статус обновления /rest/api/admin/db/updating_is_completed
5. После завершения обновления выполняем метод /rest/api/admin/db/on_db_updated

Returns:

json данные об статусе выполнения запроса
Пример возвращаемых данных метода, при успешном выполнении
{
"errorCode": 0,
"errorMessage": "Success"
}


Пример возвращаемых данных метода, в случае ошибки
{
"errorCode": 13,
"errorMessage": "Ошибка исполнения"
}

See Also:

URL: rest/api/admin/db/start_update

Type: GET

getMessages

public java.lang.String getMessages()

Сообщении об выполнения обновления базы данных. Если в сообщениях присутствует сообщение с типом "-1" ("type": -1) то обновление завершено.

URL: rest/api/admin/db/messages

Type: GET

Returns:

json данные об статусе выполнения запроса и с версией базы данных
Пример возвращаемых данных метода
{
"errorCode": 0,
"errorMessage": "Success",
"data": [{
"message": "Creating indexes",
"type": 0,
"date": 1416196612376
}, {
"message": "reports indexes created",
"type": 0,
"date": 1416196612378
}, {
"message": "Обновление завершено",
"type": -1,
"date": 1416196612378
}]
}

updatingIsCompleted

public java.lang.String updatingIsCompleted()

Проверка статуса выполнения обновление базы.

URL: rest/api/admin/db/updating_is_completed

Type: GET

Returns:

json данные об выполнении обновления базы
Пример возвращаемых данных метода, если обновление уже завершено
{
"errorCode": 0,
"errorMessage": "Success",
"data": true
}


Пример возвращаемых данных метода, если обновление еще не завершено
{
"errorCode": 0,
"errorMessage": "Success",
"data": false
}

onDbUpdated

public java.lang.String onDbUpdated()

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

URL: rest/api/admin/db/on_db_updated

Type: GET

Returns:

json данные об статусе выполнения запроса и с версией базы данных
Пример возвращаемых данных метода, при успешном выполнении
{
"errorCode": 0,
"errorMessage": "Success"
}


Пример возвращаемых данных метода, в случае ошибки
{
"errorCode": 13,
"errorMessage": "Ошибка исполнения"
}

getUserID

public java.lang.String getUserID()