protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/transport/TcpTransport.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
package org.apache.directory.server.protocol.shared.transport;


import java.net.InetSocketAddress;
import java.util.List;

import org.apache.directory.api.util.Network;
import org.apache.mina.core.service.IoAcceptor;
import org.apache.mina.transport.socket.SocketAcceptor;
import org.apache.mina.transport.socket.nio.NioSocketAcceptor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 * @todo : missing javadoc
 * 
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public class TcpTransport extends AbstractTransport
{
    /** The SSL 'needClientAuth' flag */
    private boolean needClientAuth;

    /** The SSL 'wantClientAuth' flag */
    private boolean wantClientAuth;

    /** The list of enabled protocols */
    private List<String> enabledProtocols;

    /** The list of enabled ciphers */
    private List<String> cipherSuite;

    /** A logger for this class */
    private static final Logger LOG = LoggerFactory.getLogger( TcpTransport.class );


    /**
     * Creates an instance of the TcpTransport class 
     */
    public TcpTransport()
    {
        super();
    }


    /**
     * Creates an instance of the TcpTransport class on localhost
     * @param tcpPort The port
     */
    public TcpTransport( int tcpPort )
    {
        super( null, tcpPort, DEFAULT_NB_THREADS, DEFAULT_BACKLOG_NB );

        this.acceptor = createAcceptor( null, tcpPort, DEFAULT_NB_THREADS, DEFAULT_BACKLOG_NB );

        LOG.debug( "TCP Transport created : <*:{},>", tcpPort );
    }


    /**
     * Creates an instance of the TcpTransport class on localhost
     * @param tcpPort The port
     * @param nbThreads The number of threads to create in the acceptor
     */
    public TcpTransport( int tcpPort, int nbThreads )
    {
        super( null, tcpPort, nbThreads, DEFAULT_BACKLOG_NB );

        this.acceptor = createAcceptor( null, tcpPort, nbThreads, DEFAULT_BACKLOG_NB );

        LOG.debug( "TCP Transport created : <*:{},>", tcpPort );
    }


    /**
     * Creates an instance of the TcpTransport class 
     * @param address The address
     * @param tcpPort The port
     */
    public TcpTransport( String address, int tcpPort )
    {
        super( address, tcpPort, DEFAULT_NB_THREADS, DEFAULT_BACKLOG_NB );
        this.acceptor = createAcceptor( address, tcpPort, DEFAULT_NB_THREADS, DEFAULT_BACKLOG_NB );

        LOG.debug( "TCP Transport created : <{}:{}>", address, tcpPort );
    }


    /**
     * Creates an instance of the TcpTransport class on localhost
     * @param tcpPort The port
     * @param nbThreads The number of threads to create in the acceptor
     * @param backLog The queue size for incoming messages, waiting for the
     * acceptor to be ready
     * @throws UnknownHostException 
     */
    public TcpTransport( int tcpPort, int nbThreads, int backLog )
    {
        super( Network.LOOPBACK.getHostAddress(), tcpPort, nbThreads, backLog );
        this.acceptor = createAcceptor( null, tcpPort, nbThreads, backLog );

        LOG.debug( "TCP Transport created : <*:{},>", tcpPort );
    }


    /**
     * Creates an instance of the TcpTransport class 
     * @param address The address
     * @param tcpPort The port
     * @param nbThreads The number of threads to create in the acceptor
     * @param backLog The queue size for incoming messages, waiting for the
     * acceptor to be ready
     */
    public TcpTransport( String address, int tcpPort, int nbThreads, int backLog )
    {
        super( address, tcpPort, nbThreads, backLog );
        this.acceptor = createAcceptor( address, tcpPort, nbThreads, backLog );

        LOG.debug( "TCP Transport created : <{}:{},>", address, tcpPort );
    }


    /**
     * Initialize the Acceptor if needed
     */
    public void init()
    {
        acceptor = createAcceptor( getAddress(), getPort(), getNbThreads(), getBackLog() );
    }


    /**
     * Helper method to create an IoAcceptor
     */
    private IoAcceptor createAcceptor( String address, int port, int nbThreads, int backLog )
    {
        NioSocketAcceptor acceptor = new NioSocketAcceptor( nbThreads );
        acceptor.setReuseAddress( true );
        acceptor.setBacklog( backLog );

        InetSocketAddress socketAddress = null;

        // The address can be null here, if one want to connect using the wildcard address
        if ( address == null )
        {
            // Create a socket listening on the wildcard address
            socketAddress = new InetSocketAddress( port );
        }
        else
        {
            socketAddress = new InetSocketAddress( address, port );
        }

        acceptor.setDefaultLocalAddress( socketAddress );

        return acceptor;
    }


    /**
     * @return The associated SocketAcceptor
     */
    public SocketAcceptor getAcceptor()
    {
        if ( ( acceptor != null ) && acceptor.isDisposed() )
        {
            acceptor = createAcceptor( getAddress(), getPort(), getNbThreads(), getBackLog() );
        }

        return acceptor == null ? null : ( SocketAcceptor ) acceptor;
    }


    /**
     * Set the needClientAuth SSL flag
     *
     * @param needClientAuth the flag to set
     */
    public void setNeedClientAuth( boolean needClientAuth )
    {
        this.needClientAuth = needClientAuth;
    }


    /**
     * @return <code>true</code> if the NeedClientAuth SSL flag is set
     */
    public boolean isNeedClientAuth()
    {
        return needClientAuth;
    }


    /**
     * Set the wantClientAuth SSL flag
     *
     * @param wantClientAuth the flag to set
     */
    public void setWantClientAuth( boolean wantClientAuth )
    {
        this.wantClientAuth = wantClientAuth;
    }


    /**
     * @return <code>true</code> if the WantClientAuth SSL flag is set
     */
    public boolean isWantClientAuth()
    {
        return wantClientAuth;
    }


    /**
     * @return The list of enabled protocols
     */
    public List<String> getEnabledProtocols()
    {
        return enabledProtocols;
    }


    /**
     * Set the list of enabled protocols
     *
     * @param enabledProtocols The list of enabled protocols
     */
    public void setEnabledProtocols( List<String> enabledProtocols )
    {
        this.enabledProtocols = enabledProtocols;
    }


    /**
     * @return The list of enabled ciphers
     */
    public List<String> getCipherSuite()
    {
        return cipherSuite;
    }


    /**
     * Set the list of enabled ciphers
     *
     * @param enabledCiphers The list of enabled ciphers
     */
    public void setEnabledCiphers( List<String> cipherSuite )
    {
        this.cipherSuite = cipherSuite;
    }


    /**
     * @see Object#toString()
     */
    public String toString()
    {
        return "TcpTransport" + super.toString();
    }
}