ONAP-XACML/src/main/java/org/onap/policy/xacml/api/pap/ONAPPapEngineFactory.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP-XACML
   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.xacml.api.pap;
  22
  23 import com.att.research.xacml.api.pap.PAPException;
  24 import com.att.research.xacml.util.FactoryException;
  25 import com.att.research.xacml.util.FactoryFinder;
  26
  27 import java.util.Properties;
  28
  29 public abstract class ONAPPapEngineFactory {
  30
  31     /**
  32      * Creates a new <code>PAPEngineFactory</code> instance using the given class name and the default thread class
  33      * loader.
  34      *
  35      * @param factoryClassName the <code>String</code> name of the factory class to instantiate
  36      * @return an instance of an object that extends <code>ONAPPapEngineFactory</code> to use in creating
  37      *         <code>PAPPolicyEngine</code> objects.
  38      */
  39     public static ONAPPapEngineFactory newInstance(String factoryClassName) throws FactoryException {
  40         return FactoryFinder.newInstance(factoryClassName, ONAPPapEngineFactory.class, null, true);
  41     }
  42
  43     /**
  44      * Creates a new <code>PAPPolicyEngine</code> based on the configured <code>ONAPPapEngineFactory</code>.
  45      *
  46      * @return a new <code>PAPPolicyEngine</code>
  47      * @throws PAPException PAPException
  48      */
  49     public abstract PAPPolicyEngine newEngine() throws FactoryException, PAPException;
  50
  51     /**
  52      * Creates a new <code>PAPPolicyEngine</code> based on the configured <code>ONAPPapEngineFactory</code>.
  53      *
  54      * @return a new <code>PAPPolicyEngine</code>
  55      * @throws PAPException PAPException
  56      */
  57     public abstract PAPPolicyEngine newEngine(Properties properties) throws FactoryException, PAPException;
  58
  59 }