TransportChannelFactory xref

View Javadoc

    1   /***
    2    *
    3    * Copyright 2004 Protique Ltd
    4    *
    5    * Licensed under the Apache License, Version 2.0 (the "License");
    6    * you may not use this file except in compliance with the License.
    7    * You may obtain a copy of the License at
    8    *
    9    * http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   *
    17   **/
    18  package org.codehaus.activemq.transport;
    19
    20  import org.codehaus.activemq.message.WireFormat;
    21
    22  import javax.jms.JMSException;
    23  import java.net.URI;
    24
    25  /***
    26   * TransportChannelFactory for creating TransportChannels
    27   *
    28   * @version $Revision: 1.5 $
    29   */
    30  public interface TransportChannelFactory {
    31      /***
    32       * Create a Channel to a remote Node - e.g. a Broker
    33       *
    34       * @param wireFormat
    35       * @param remoteLocation
    36       * @return the TransportChannel bound to the remote node
    37       * @throws JMSException
    38       */
    39      public TransportChannel create(WireFormat wireFormat, URI remoteLocation) throws JMSException;
    40
    41      /***
    42       * Create a Channel to a remote Node - e.g. a Broker
    43       *
    44       * @param wireFormat
    45       * @param remoteLocation
    46       * @param localLocation  -
    47       *                       e.g. local InetAddress and local port
    48       * @return the TransportChannel bound to the remote node
    49       * @throws JMSException
    50       */
    51      public TransportChannel create(WireFormat wireFormat, URI remoteLocation, URI localLocation) throws JMSException;
    52
    53      /***
    54       * Does this channel require an embedded broker to perform
    55       * such as VM or multicast based transports
    56       *
    57       * @return true if an embedded broker is a requirement
    58       *         of using the channel
    59       */
    60      public boolean requiresEmbeddedBroker();
    61  }