ONAP-PAP-REST/src/main/java/org/onap/policy/pap/xacml/rest/handler/DictionaryHandler.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP-PAP-REST
   4  * ================================================================================
   5  * Copyright (C) 2017, 2019 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 package org.onap.policy.pap.xacml.rest.handler;
  22
  23 import com.att.research.xacml.util.XACMLProperties;
  24
  25 import javax.servlet.http.HttpServletRequest;
  26 import javax.servlet.http.HttpServletResponse;
  27
  28 import org.onap.policy.common.logging.flexlogger.FlexLogger;
  29 import org.onap.policy.common.logging.flexlogger.Logger;
  30
  31 public interface DictionaryHandler {
  32     public static final Logger logger = FlexLogger.getLogger(DictionaryHandler.class);
  33     String DICTIONARY_DEFAULT_CLASS = DictionaryHandlerImpl.class.getName();
  34
  35     /*
  36      * Get Instance
  37      */
  38     public static DictionaryHandler getInstance() {
  39         try {
  40             Class<?> dictionaryHandler =
  41                     Class.forName(XACMLProperties.getProperty("dictionary.impl.className", DICTIONARY_DEFAULT_CLASS));
  42             DictionaryHandler instance = (DictionaryHandler) dictionaryHandler.newInstance();
  43             return instance;
  44         } catch (Exception e) {
  45             logger.error(e.getMessage(), e);
  46         }
  47         return null;
  48     }
  49
  50     /*
  51      * Get Equivalent for Dictionary Services.
  52      */
  53     public void doDictionaryAPIGet(HttpServletRequest request, HttpServletResponse response);
  54
  55     /*
  56      * Put Equivalent for Dictionary Services.
  57      */
  58     public void doDictionaryAPIPut(HttpServletRequest request, HttpServletResponse response);
  59
  60     /**
  61      * Can be used to extend the services.
  62      *
  63      * getflag=true indicates Get Request.
  64      * getflag=false indicates Put Request.
  65      *
  66      * @return
  67      */
  68     public String extendedOptions(String dictionaryType, HttpServletRequest request, HttpServletResponse response,
  69             boolean getflag);
  70 }