testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/utils/ConfigrationProvider.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2018 Ericsson. All rights reserved.
   4  *  Modifications Copyright (C) 2019 Nordix Foundation.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.apex.testsuites.integration.context.utils;
  23
  24 import java.util.Map;
  25 import java.util.concurrent.ExecutorService;
  26 import org.onap.policy.apex.context.ContextAlbum;
  27 import org.onap.policy.apex.context.ContextException;
  28 import org.onap.policy.apex.context.Distributor;
  29 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  30 import org.onap.policy.apex.testsuites.integration.context.lock.modifier.AlbumModifier;
  31 import org.onap.policy.apex.testsuites.integration.context.lock.modifier.LockType;
  32
  33 /**
  34  * The Interface ConfigrationProvider provides the configuration for a context test to a context test executor.
  35  */
  36 public interface ConfigrationProvider {
  37
  38     /**
  39      * Gets the test name.
  40      *
  41      * @return the test name
  42      */
  43     String getTestName();
  44
  45     /**
  46      * Gets the loop size.
  47      *
  48      * @return the loop size
  49      */
  50     int getLoopSize();
  51
  52     /**
  53      * Gets the thread count.
  54      *
  55      * @return the thread count
  56      */
  57     int getThreadCount();
  58
  59     /**
  60      * Gets the jvm count.
  61      *
  62      * @return the jvm count
  63      */
  64     int getJvmCount();
  65
  66     /**
  67      * Gets the album size.
  68      *
  69      * @return the album size
  70      */
  71     int getAlbumSize();
  72
  73     /**
  74      * Gets the executor service.
  75      *
  76      * @return the executor service
  77      */
  78     ExecutorService getExecutorService();
  79
  80     /**
  81      * Gets the executor service.
  82      *
  83      * @param threadFactoryName the thread factory name
  84      * @param threadPoolSize the thread pool size
  85      * @return the executor service
  86      */
  87     ExecutorService getExecutorService(final String threadFactoryName, final int threadPoolSize);
  88
  89     /**
  90      * Gets the distributor.
  91      *
  92      * @param key the key
  93      * @return the distributor
  94      */
  95     Distributor getDistributor(final AxArtifactKey key);
  96
  97     /**
  98      * Gets the distributor.
  99      *
 100      * @return the distributor
 101      */
 102     Distributor getDistributor();
 103
 104     /**
 105      * Gets the context album.
 106      *
 107      * @param distributor the distributor
 108      * @return the context album
 109      */
 110     ContextAlbum getContextAlbum(final Distributor distributor);
 111
 112     /**
 113      * Gets the context album.
 114      *
 115      * @param distributor the distributor
 116      * @param axContextAlbumKey the ax context album key
 117      * @param artifactKeys the artifact keys
 118      * @return the context album
 119      * @throws ContextException the context exception
 120      */
 121     ContextAlbum getContextAlbum(final Distributor distributor, AxArtifactKey axContextAlbumKey,
 122                     AxArtifactKey[] artifactKeys) throws ContextException;
 123
 124     /**
 125      * Gets the context album init values.
 126      *
 127      * @return the context album init values
 128      */
 129     Map<String, Object> getContextAlbumInitValues();
 130
 131     /**
 132      * Gets the album modifier.
 133      *
 134      * @return the album modifier
 135      */
 136     AlbumModifier getAlbumModifier();
 137
 138     /**
 139      * Gets the lock type.
 140      *
 141      * @return the lock type
 142      */
 143     LockType getLockType();
 144
 145 }