FilterAction.java

/**
 * Licensed to the Austrian Association for Software Tool Integration (AASTI)
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. The AASTI 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.openengsb.core.api.remote;

import java.util.Map;

/**
 * Represents an Action in a filter-chain. Implementing this interface ensures that the class can be used in a
 * filterchain configuration.
 *
 */
public interface FilterAction {

    /**
     * Transforms the input-value received from the previous filter to an output value that is then returned.
     *
     * @throws FilterException if some Exception occurs. All Exception should be wrapped in a {@link FilterException} so
     *         that they can be treated at the end of the chain.
     */
    Object filter(Object input, Map<String, Object> metaData) throws FilterException;

    /**
     * This is required to check the compatibility of filters at runtime (since the type-parameters are not available at
     * runtime)
     */
    Class<?> getSupportedInputType();

    /**
     * This is required to check the compatibility of filters at runtime (since the type-parameters are not available at
     * runtime)
     */
    Class<?> getSupportedOutputType();

}