appc-client/client-lib/src/main/java/org/openecomp/appc/client/impl/core/IInvocationManager.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25 package org.openecomp.appc.client.impl.core;
  26
  27 import java.util.Properties;
  28 import java.util.concurrent.TimeoutException;
  29
  30 /**
  31  */
  32 public interface IInvocationManager {
  33
  34     /**
  35      * initializes the manager
  36      * @param prop properties to read from
  37      * @throws CoreException thrown if madatory fields are not set right
  38      */
  39     void init(Properties prop) throws CoreException;
  40
  41     /**
  42      * handles the flow of an async request
  43      * @param request the request body
  44      * @param listener business response handler
  45      * @param correlationId unique id of the request
  46      * @param rpcName rpc call name
  47      * @throws CoreException thrown if the request failed to be sent
  48      */
  49     void asyncRequest(String request, ICoreAsyncResponseHandler listener, String correlationId, String rpcName) throws CoreException;
  50
  51     /**
  52      * handles to flow of a sync request
  53      * @param request the request body
  54      * @param callback business response handler
  55      * @param correlationId unique id of the request
  56      * @param rpcName rpc call name
  57      * @return the output object to be returned
  58      * @throws CoreException thrown if the request failed to be sent
  59      * @throws TimeoutException thrown if timeout has exceeded
  60      */
  61     <T> T syncRequest(String request, ICoreSyncResponseHandler callback, String correlationId, String rpcName) throws CoreException, TimeoutException;
  62
  63     /**
  64      * shuts the invocation manager down.
  65      * @param isForceShutdown if true, shutdown will be forced, otherwise it will be gracefully
  66      */
  67     void shutdown(boolean isForceShutdown);
  68 }