authz-gw/src/main/java/com/att/authz/gw/facade/GwFacade.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START====================================================\r
   3  * * org.onap.aai\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * Copyright © 2017 Amdocs\r
   7  * * ===========================================================================\r
   8  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   9  * * you may not use this file except in compliance with the License.\r
  10  * * You may obtain a copy of the License at\r
  11  * * \r
  12  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  13  * * \r
  14  *  * Unless required by applicable law or agreed to in writing, software\r
  15  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  16  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  17  * * See the License for the specific language governing permissions and\r
  18  * * limitations under the License.\r
  19  * * ============LICENSE_END====================================================\r
  20  * *\r
  21  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  22  * *\r
  23  ******************************************************************************/\r
  24 package com.att.authz.gw.facade;\r
  25 \r
  26 import javax.servlet.http.HttpServletResponse;\r
  27 \r
  28 import com.att.authz.env.AuthzTrans;\r
  29 import com.att.authz.layer.Result;\r
  30 import com.att.cssa.rserv.RServlet;\r
  31 \r
  32 \r
  33 /**\r
  34  *   \r
  35  *\r
  36  */\r
  37 public interface GwFacade {\r
  38 \r
  39 /////////////////////  STANDARD ELEMENTS //////////////////\r
  40         /** \r
  41          * @param trans\r
  42          * @param response\r
  43          * @param result\r
  44          */\r
  45         void error(AuthzTrans trans, HttpServletResponse response, Result<?> result);\r
  46 \r
  47         /**\r
  48          * \r
  49          * @param trans\r
  50          * @param response\r
  51          * @param status\r
  52          */\r
  53         void error(AuthzTrans trans, HttpServletResponse response, int status,  String msg, String ... detail);\r
  54 \r
  55 \r
  56         /**\r
  57          * \r
  58          * @param trans\r
  59          * @param resp\r
  60          * @param rservlet\r
  61          * @return\r
  62          */\r
  63         public Result<Void> getAPI(AuthzTrans trans, HttpServletResponse resp, RServlet<AuthzTrans> rservlet);\r
  64 \r
  65         /**\r
  66          * \r
  67          * @param trans\r
  68          * @param resp\r
  69          * @param typeCode\r
  70          * @param optional\r
  71          * @return\r
  72          */\r
  73         public abstract Result<Void> getAPIExample(AuthzTrans trans, HttpServletResponse resp, String typeCode, boolean optional);\r
  74 \r
  75 }\r