001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.util.component;
018
019import org.apache.camel.Exchange;
020
021/**
022 * Intercepts API method invocation result Exchange.
023 */
024public interface ResultInterceptor {
025
026    /**
027     * Split a complex result into result elements.
028     * @param result API method invocation result
029     * @return either the same result if it cannot be split, or an array object with split results
030     */
031    Object splitResult(Object result);
032
033    /**
034     * Do additional result exchange processing, for example, adding custom headers.
035     * @param result result of API method invocation.
036     * @param resultExchange result as a Camel exchange, may be a split result from Arrays or Collections.
037     */
038    void interceptResult(Object result, Exchange resultExchange);
039}