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