auth/auth-locate/src/main/java/org/onap/aaf/auth/locate/facade/LocateFacade.java

   1 /**
   2  * ============LICENSE_START====================================================
   3  * org.onap.aaf
   4  * ===========================================================================
   5  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   6  * ===========================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END====================================================
  19  *
  20  */
  21
  22 package org.onap.aaf.auth.locate.facade;
  23
  24 import javax.servlet.http.HttpServletRequest;
  25 import javax.servlet.http.HttpServletResponse;
  26
  27 import org.onap.aaf.auth.env.AuthzTrans;
  28 import org.onap.aaf.auth.layer.Result;
  29 import org.onap.aaf.auth.rserv.RServlet;
  30
  31
  32 /**
  33  *
  34  * @author Jonathan
  35  *
  36  */
  37 public interface LocateFacade {
  38
  39 /////////////////////  STANDARD ELEMENTS //////////////////
  40     /**
  41      * @param trans
  42      * @param response
  43      * @param result
  44      */
  45     void error(AuthzTrans trans, HttpServletResponse response, Result<?> result);
  46
  47     /**
  48      *
  49      * @param trans
  50      * @param response
  51      * @param status
  52      */
  53     void error(AuthzTrans trans, HttpServletResponse response, int status,    String msg, String ... detail);
  54
  55
  56     /**
  57      *
  58      * @param trans
  59      * @param resp
  60      * @param rservlet
  61      * @return
  62      */
  63     public Result<Void> getAPI(AuthzTrans trans, HttpServletResponse resp, RServlet<AuthzTrans> rservlet);
  64
  65     /**
  66      *
  67      * @param trans
  68      * @param resp
  69      * @param typeCode
  70      * @param optional
  71      * @return
  72      */
  73     public abstract Result<Void> getAPIExample(AuthzTrans trans, HttpServletResponse resp, String typeCode, boolean optional);
  74
  75     /**
  76      *
  77      * @param trans
  78      * @param resp
  79      * @param service
  80      * @param version
  81      * @param other
  82      * @param string
  83      * @return
  84      */
  85     public abstract Result<Void> getEndpoints(AuthzTrans trans, HttpServletResponse resp, String key,
  86             String service, String version, String other);
  87
  88     /**
  89      *
  90      * @param trans
  91      * @param req
  92      * @param resp
  93      * @return
  94      */
  95     public abstract Result<Void> putMgmtEndpoints(AuthzTrans trans, HttpServletRequest req, HttpServletResponse resp);
  96
  97     /**
  98      *
  99      * @param trans
 100      * @param req
 101      * @param resp
 102      * @return
 103      */
 104     public abstract Result<Void> removeMgmtEndpoints(AuthzTrans trans, HttpServletRequest req, HttpServletResponse resp);
 105
 106     /**
 107      *
 108      * @param trans
 109      * @param req
 110      * @param resp
 111      * @return
 112      */
 113     public Result<Void> getConfig(AuthzTrans trans, HttpServletRequest req, HttpServletResponse resp, String id, String type);
 114
 115 }