appc-client/client-lib/src/main/java/org/onap/appc/client/impl/core/RequestResponseHandler.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 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  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.appc.client.impl.core;
  25
  26 interface RequestResponseHandler {
  27
  28     /**
  29      * sends request, registers handler of response and start timer.
  30      * @param request - Request
  31      * @param corrId - correlation ID
  32      * @param rpcName - RPC name
  33      * @throws CoreException - @{@link CoreException}
  34      */
  35     void sendRequest(String request, String corrId, String rpcName) throws CoreException;
  36
  37     /**
  38      * submits a handler task to task queue @{@link TaskQueue}, this task will be performed only if this handler is
  39      * still existing in core registry @{@link CoreRegistry}, others timeout was occurred .
  40      * @param ctx - Message Context @{@link MessageContext}
  41      * @param response - Response from backend
  42      */
  43     void handleResponse(MessageContext ctx, String response);
  44
  45     /**
  46      * handles timeout event
  47      */
  48     void onTimeOut();
  49 }