src/site/ru/apt/examples/handle-the-api-exceptions.apt.vm

   1  ------
   2  Обработка исключений, возникающих при работе с API
   3  ------
   4  Dmitry Samoshin aka gotty
   5  ------
   6  2017-01-27
   7  ------
   8
   9 ~~ Copyright (c) 2017. Developed by Hedgecode.
  10 ~~
  11 ~~ Licensed under the Apache License, Version 2.0 (the "License");
  12 ~~ you may not use this file except in compliance with the License.
  13 ~~ You may obtain a copy of the License at
  14 ~~
  15 ~~   http://www.apache.org/licenses/LICENSE-2.0
  16 ~~
  17 ~~ Unless required by applicable law or agreed to in writing, software
  18 ~~ distributed under the License is distributed on an "AS IS" BASIS,
  19 ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  20 ~~ See the License for the specific language governing permissions and
  21 ~~ limitations under the License.
  22
  23 ~~ NOTE: For help with the syntax of this file, see:
  24 ~~ http://maven.apache.org/doxia/references/apt-format.html
  25
  26 Обработка исключений, возникающих при работе с API
  27
  28   В данной библиотеке реализовано основное исключение <<<APIException>>>, которое
  29   при возникновении исключительных ситуаций может сообщать клиентскому приложению
  30   о типе возникшей ошибке в процессе использования библиотечных методов.\
  31   Данное исключение может уведомлять о двух типах исключительных ситуаций:
  32
  33 +-------
  34 public class APIException extends Exception {
  35
  36     public static enum Type {
  37         INFO,
  38         REQUEST
  39     }
  40     ...
  41 }
  42 +-------
  43
  44   Получить тип возникшего исключения можно при помощи метода <<<APIException.getType()>>>.
  45
  46   Тип <<<INFO>>> сообщает клиентскому приложению о том, что возникшее исключение не является
  47   критическим и не связано с невозможностью получить полезную информацию.
  48   Работа приложения может быть продолжена после обнаружения данного типа исключения без
  49   серьезных последствий, но с определенными корректировками в дальнейшем рабочем функционале.
  50
  51   Тип <<<REQUEST>>> сообщает клиентскому приложению о том, что возникшее исключение связано
  52   с процессом получения полезной информации с портала {{{http://snooker.org/}snooker.org}}, либо
  53   с невозможностью обработать полученную информацию.\
  54   Данный тип исключения может возникнуть по нескольким причинам:
  55
  56   <<1.>> Данные, переданные API-методу, некорректны. Такое может возникнуть в случае передачи
  57   некорректного входного ID (турнира, игрока и пр.) или же <<null>>-параметра. В данном случае
  58   работа приложения может быть продолжена после корректировки передаваемых параметров.
  59
  60   <<2.>> Нарушение канала связи (доступа к порталу). Информация просто не может быть получена.
  61   В данном случае клиентское приложение не может продолжать работать до установления нормального
  62   интернет-соединения.
  63
  64   <<3.>> API самого портала претерпело изменения. Входящие данные не могут быть корректно обработаны.
  65   Этот случай самый существенный. Он означает, что текущая версия библиотеки уже не может считаться
  66   работоспособной. Необходимо проверить наличие более свежей версии данной библиотеки, и если таковая
  67   отсутствует, то сообщить разработчику о выявленном несоответствии API библиотеки
  68   и портала {{{http://api.snooker.org/}api.snooker.org}}.