mq5.0-source.main.mq-client.src.main.java.com.sun.messaging.jmq.jmsclient.ConnectionHandler Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2000-2012 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

/*
 * @(#)ConnectionHandler.java	1.5 06/27/07
 */ 

package com.sun.messaging.jmq.jmsclient;

import java.io.*;
import java.util.Properties;

import com.sun.messaging.jmq.io.ReadWritePacket;

/**
 *  The connection handler knows how to communicate with the broker uses the
 *  specified protocol.
 *
 *  The implementation of InputStream and OutputStream should be in the way
 *  that no protocol specific values are exposed to the API user.
 */
public interface ConnectionHandler {

    public InputStream
    getInputStream() throws IOException;

    public OutputStream
    getOutputStream() throws IOException;

    public int
    getLocalPort() throws IOException;

    public void
    close() throws IOException;

    public String getBrokerHostName();

    /**
     * Get broker address.
     *
     * @return [host,port] for TCP and SSL protocols.
     *         URL string for HTTP/HTTPS protocols.
     */
    public String getBrokerAddress();
    
    public ReadWritePacket readPacket() throws IOException;
    public void writePacket (ReadWritePacket pkt) throws IOException;
    
    public void configure(Properties configuration) throws IOException;
    
    public boolean isDirectMode();
	
}