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
    19  package org.codehaus.activemq.transport;
    20
    21  import org.codehaus.activemq.service.Service;
    22
    23  import javax.jms.JMSException;
    24
    25  /***
    26   * Represents a Server which accepts incoming client connections
    27   * in the form of TransportChannels which is used inside the JMS Broker
    28   *
    29   * @version $Revision: 1.8 $
    30   */
    31  public interface TransportServerChannel extends Service {
    32
    33      /***
    34       * close the ServerChannel
    35       */
    36      public void stop() throws JMSException;
    37
    38
    39      /***
    40       * start listeneing for events
    41       *
    42       * @throws JMSException if an error occurs
    43       */
    44      public void start() throws JMSException;
    45
    46      /***
    47       * Registers the listener to be used when new clients connect or
    48       * disconnect
    49       *
    50       * @param listener the listener to be invoked when a client connects
    51       *                 or disconnects
    52       */
    53      public void setTransportChannelListener(TransportChannelListener listener);
    54
    55      /***
    56       * Returns the URL to connect to this connector
    57       */
    58      String getUrl();
    59  }