datarouter-prov/src/main/java/org/onap/dmaap/datarouter/authz/impl/AuthRespImpl.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 \r
  24 \r
  25 package org.onap.dmaap.datarouter.authz.impl;\r
  26 \r
  27 import java.util.ArrayList;\r
  28 import java.util.List;\r
  29 \r
  30 import org.onap.dmaap.datarouter.authz.AuthorizationResponse;\r
  31 import org.onap.dmaap.datarouter.authz.AuthorizationResponseSupplement;\r
  32 \r
  33 \r
  34 /** A representation of an authorization response returned by a XACML Policy Decision Point.\r
  35  *  In Data Router R1, advice and obligations are not used.\r
  36  * @author J. F. Lucas\r
  37  *\r
  38  */\r
  39 public class AuthRespImpl implements AuthorizationResponse {\r
  40         private boolean authorized;\r
  41         private List<AuthorizationResponseSupplement> advice;\r
  42         private List<AuthorizationResponseSupplement> obligations;\r
  43         \r
  44         /** Constructor.  This version will not be used in Data Router R1 since we will not have advice and obligations.\r
  45          * \r
  46          * @param authorized flag indicating whether the response carried a permit response (<code>true</code>) \r
  47          * or something else (<code>false</code>).\r
  48          * @param advice list of advice elements returned in the response.\r
  49          * @param obligations list of obligation elements returned in the response.\r
  50          */\r
  51         public AuthRespImpl(boolean authorized, List<AuthorizationResponseSupplement> advice, List<AuthorizationResponseSupplement> obligations) {\r
  52                 this.authorized = authorized;\r
  53                 this.advice = (advice == null ? null : new ArrayList<AuthorizationResponseSupplement> (advice));\r
  54                 this.obligations = (obligations == null ? null : new ArrayList<AuthorizationResponseSupplement> (obligations));\r
  55         }\r
  56         \r
  57         /** Constructor.  Simple version for authorization responses that have no advice and no obligations.\r
  58          * \r
  59          * @param authorized flag indicating whether the response carried a permit (<code>true</code>) or something else (<code>false</code>).\r
  60          */\r
  61         public AuthRespImpl(boolean authorized) {\r
  62                 this(authorized, null, null);\r
  63         }\r
  64 \r
  65         /**\r
  66          * Indicates whether the request is authorized or not.\r
  67          * \r
  68          * @return a boolean flag that is <code>true</code> if the request is permitted, and <code>false</code> otherwise.\r
  69          */\r
  70         @Override\r
  71         public boolean isAuthorized() {\r
  72                         return authorized;\r
  73         }\r
  74 \r
  75         /**\r
  76          * Returns any advice elements that were included in the authorization response.\r
  77          * \r
  78          * @return A list of objects implementing the <code>AuthorizationResponseSupplement</code> interface, with each object representing an\r
  79          * advice element from the authorization response.\r
  80          */\r
  81         @Override\r
  82         public List<AuthorizationResponseSupplement> getAdvice() {\r
  83                         return advice;\r
  84         }\r
  85 \r
  86         /**\r
  87          * Returns any obligation elements that were included in the authorization response.\r
  88          * \r
  89          * @return A list of objects implementing the <code>AuthorizationResponseSupplement</code> interface, with each object representing an\r
  90          * obligation element from the authorization response.\r
  91          */\r
  92         @Override\r
  93         public List<AuthorizationResponseSupplement> getObligations() {\r
  94                 return obligations;\r
  95         }\r
  96 \r
  97 }\r