org.fabric3.spi.model.physical.PhysicalConnectionSource 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
There is a newer version: 3.1.0
/*
 * 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.model.physical;

import org.fabric3.api.model.type.contract.DataType;

/**
 * Used to attach the source side of a channel connection. The source may be a producer, channel binding, or channel.
 */
public class PhysicalConnectionSource extends PhysicalAttachPoint {

    public static final int NO_SEQUENCE = 0;

    private int sequence = NO_SEQUENCE;
    private boolean directConnection;
    private Class serviceInterface;
    private String topic;

    public PhysicalConnectionSource() {
    }

    public PhysicalConnectionSource(DataType... types) {
        super(types);
    }

    /**
     * Returns an id for the connection target. Connections may be cached and reused if their source and target ids match.
     *
     * Bindings will override the default method if the connection from a transport to a channel should be re-used (i.e. guarantee only one is created per
     * runtime).
     *
     * @return the id
     */
    public String getSourceId() {
        return getUri().toString() + "_source_" + this.getClass().getName() + "#"+ getTopic();
    }

    /**
     * Returns the sequence a consumer should be passed events, if supported by the channel type.
     *
     * @return the sequence a consumer should be passed events, if supported by the channel type
     */
    public int getSequence() {
        return sequence;
    }

    /**
     * Sets the sequence a consumer should be passed events, if supported by the channel type.
     *
     * @param sequence the sequence a consumer should be passed events, if supported by the channel type.
     */
    public void setSequence(int sequence) {
        this.sequence = sequence;
    }

    /**
     * Sets the connection as a direct connection, i.e. the client connects using the underlying binding or channel dispatcher API.
     *
     * @param directConnection true if this is a direct connection
     */
    public void setDirectConnection(boolean directConnection) {
        this.directConnection = directConnection;
    }

    /**
     * Returns true if the connection as a direct connection, i.e. the client connects using the underlying binding or channel dispatcher API.
     *
     * @return true if this is a direct connection
     */
    public boolean isDirectConnection() {
        return directConnection;
    }

    /**
     * Returns the Java interface for the service contract.
     *
     * @return the Java interface for the service contract
     */
    public Class getServiceInterface() {
        return serviceInterface;
    }

    /**
     * Sets the Java interface for the service contract.
     *
     * @param interfaze the Java interface for the service contract
     */
    public void setServiceInterface(Class interfaze) {
        this.serviceInterface = interfaze;
    }

    /**
     * Sets the topic name this connection receives from.
     *
     * @param topic the topic
     */
    public void setTopic(String topic) {
        this.topic = topic;
    }

    /**
     * Returns the topic name this connection receives from.
     *
     * @return topic the topic
     */
    public String getTopic() {
        return topic;
    }
}