org.fabric3.spi.container.builder.SourceWireAttacher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fabric3-spi Show documentation
Fabric3
The newest version!
/*
 * Fabric3
 * Copyright (c) 2009-2015 Metaform Systems
 *
 * Licensed 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.
 *
 * Portions originally based on Apache Tuscany 2007
 * licensed under the Apache 2.0 license.
 */
package org.fabric3.spi.container.builder;

import java.util.function.Supplier;

import org.fabric3.api.host.Fabric3Exception;
import org.fabric3.spi.container.wire.Wire;
import org.fabric3.spi.model.physical.PhysicalWireSource;
import org.fabric3.spi.model.physical.PhysicalWireTarget;

/**
 * Attaches (and detaches) a wire from a source component or transport binding.
 */
public interface SourceWireAttacher {
    /**
     * Attaches a wire to a source component or an incoming binding.
     *
     * @param source metadata for the source side of the wire
     * @param target metadata for the target side of the wire
     * @param wire   the wire
     * @throws Fabric3Exception if an exception occurs during the attach operation
     */
    void attach(PSD source, PhysicalWireTarget target, Wire wire) throws Fabric3Exception;

    /**
     * Attaches a Supplier that returns a direct target instance to a source component.
     *
     * @param source   the definition of the component reference to attach to
     * @param supplier a Supplier that can produce values compatible with the reference
     * @param target   the target definition for the wire
     * @throws Fabric3Exception if an exception occurs during the attach operation
     */
    default void attachSupplier(PSD source, Supplier supplier, PhysicalWireTarget target) throws Fabric3Exception {

    }

    /**
     * Detaches a wire from a source component or transport binding.
     *
     * @param source metadata for the source side of the wire
     * @param target metadata for the target side of the wire
     * @throws Fabric3Exception if an exception occurs during the attach operation
     */
    void detach(PSD source, PhysicalWireTarget target) throws Fabric3Exception;

    /**
     * detaches a Supplier from a source component.
     *
     * @param source the definition of the component reference to detach
     * @param target the target definition for the wire
     * @throws Fabric3Exception if an exception occurs during the deattach operation
     */
    default void detachSupplier(PSD source, PhysicalWireTarget target) throws Fabric3Exception {

    }

}