/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.    
 */
package org.apache.tuscany.sca.invocation;

/**
 * Allows asynchronous wires to be navigated in reverse in order for the 
 * response to be processed. 
 *
 */
public interface InterceptorAsync extends Interceptor, InvokerAsyncRequest, InvokerAsyncResponse {

    /**
     * Sets the previous invoker
     * @param next The previous invoker
     */
    void setPrevious(InvokerAsyncResponse previous);

    /**
     * Returns the previous invoker or null
     * @return The previous Invoker
     */
    InvokerAsyncResponse getPrevious();
    
    /**
     * Process a request message. Provided so that the synchronous
     * and asynchronous patterns can re-use the request message
     * processing 
     *
     * @param msg The request Message
     * @return the processed message
     * 
     */
    Message processRequest(Message msg);
 
    /**
     * Post processing for a request message. Intended to be called after
     * the invocation of the request chain returns, to permit cleanup/error handling
     * if required
     * @param msg The request Message
     * @return the processed message
     */
    Message postProcessRequest(Message msg);

    /**
     * Post processing for a request message where an exception was thrown. 
     * Intended to be called after the invocation of the request chain returns, 
     * to permit cleanup/error handling if required
     * @param msg The request Message
     * @param e a Thowable which is some form of exception thrown during the processing
     * of the request message by the invocation chain
     * @return the processed message
     */
    Message postProcessRequest(Message msg, Throwable e) throws Throwable;
    
    /**
     * Process a response message. Provided so that the synchronous
     * and asynchronous patterns can re-use the response message
     * processing 
     *
     * @param msg The response Message
     * @return the processed message
     * 
     */
    Message processResponse(Message msg); 
    
} // end interface InterceptorAsync