gerrit.onap Code Review - sdc.git/blob

   1 /*
   2  * Copyright © 2016-2018 European Support Limited
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.openecomp.sdc.logging.servlet;
  18
  19 import org.openecomp.sdc.logging.api.StatusCode;
  20
  21 /**
  22  * Interpretation of request processing results.
  23  *
  24  * @author evitaliy
  25  * @since 02 Aug 2018
  26  */
  27 public interface RequestProcessingResult {
  28
  29     /**
  30      * Numeric status code.
  31      *
  32      * @return usually HTTP response status.
  33      */
  34     int getStatus();
  35
  36     /**
  37      * Whether the response is considered success or failure.
  38      *
  39      * @return on of pre-defined status codes
  40      */
  41     StatusCode getStatusCode();
  42
  43     /**
  44      * Human-friendly description of the numeric status.
  45      *
  46      * @return usually HTTP reason phrase
  47      */
  48     String getStatusPhrase();
  49 }