datarouter-prov/src/main/java/com/att/research/datarouter/authz/AuthorizationResponse.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START==================================================\r
   3  * * org.onap.dmaap\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * ===========================================================================\r
   7  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * * you may not use this file except in compliance with the License.\r
   9  * * You may obtain a copy of the License at\r
  10  * * \r
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * * \r
  13  *  * Unless required by applicable law or agreed to in writing, software\r
  14  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * * See the License for the specific language governing permissions and\r
  17  * * limitations under the License.\r
  18  * * ============LICENSE_END====================================================\r
  19  * *\r
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  21  * *\r
  22  ******************************************************************************/\r
  23 package com.att.research.datarouter.authz;\r
  24 \r
  25 import java.util.List;\r
  26 \r
  27 /**\r
  28  * The <code>AuthorizationResponse</code> interface gives the caller access to information about an authorization\r
  29  * decision.  This information includes the permit/deny decision itself, along with supplementary information in the form of\r
  30  * advice and obligations.  (The advice and obligations will not be used in Data Router R1.)\r
  31  * \r
  32  * @author J. F. Lucas\r
  33  *\r
  34  */\r
  35 public interface AuthorizationResponse {\r
  36         /**\r
  37          * Indicates whether the request is authorized or not.\r
  38          * \r
  39          * @return a boolean flag that is <code>true</code> if the request is permitted, and <code>false</code> otherwise.\r
  40          */\r
  41         public boolean isAuthorized();\r
  42         \r
  43         /**\r
  44          * Returns any advice elements that were included in the authorization response.\r
  45          * \r
  46          * @return A list of objects implementing the <code>AuthorizationResponseSupplement</code> interface, with each object representing an\r
  47          * advice element from the authorization response.\r
  48          */\r
  49         public List<AuthorizationResponseSupplement> getAdvice();\r
  50         \r
  51         /**\r
  52          * Returns any obligation elements that were included in the authorization response.\r
  53          * \r
  54          * @return A list of objects implementing the <code>AuthorizationResponseSupplement</code> interface, with each object representing an\r
  55          * obligation element from the authorization response.\r
  56          */\r
  57         public List<AuthorizationResponseSupplement> getObligations();\r
  58 }\r