org.filesys.oncrpc.RpcClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfileserver Show documentation
Java file server with SMB, FTP/FTPS and NFS support, virtual filesystems, database filesystems
The newest version!
/*
 * Copyright (C) 2006-2010 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see .
 */

package org.filesys.oncrpc;

import java.io.IOException;
import java.net.InetAddress;
import java.net.SocketException;

/**
 * RPC Client Class
 *
 * Provides either a socket or datagram connection to an RPC server.
 *
 * @author gkspencer
 */
public abstract class RpcClient {

    //	Network address and port to connect to on the remote RPC server
    private InetAddress m_server;
    private int m_port;

    //	Protocol type
    private Rpc.ProtocolId m_protocol;

    //	Maximum RPC size to send/receive
    private int m_maxRpcSize;

    /**
     * Class constructor
     *
     * @param addr       InetAddress
     * @param port       int
     * @param proto      Rpc.ProtocolId
     * @param maxRpcSize int
     * @exception IOException Socket error
     * @exception SocketException Socket error
     */
    protected RpcClient(InetAddress addr, int port, Rpc.ProtocolId proto, int maxRpcSize)
            throws IOException, SocketException {

        //	Save the server address, port and the protocol type
        m_server = addr;
        m_port = port;

        m_protocol = proto;

        //	Set the maximum RPC size to send/recieve
        m_maxRpcSize = maxRpcSize;
    }

    /**
     * Return the maximum RPC size
     *
     * @return int
     */
    public final int getMaximumRpcSize() {
        return m_maxRpcSize;
    }

    /**
     * Return the server address
     *
     * @return InetAddress
     */
    public final InetAddress getServerAddress() {
        return m_server;
    }

    /**
     * Return the server port
     *
     * @return int
     */
    public final int getServerPort() {
        return m_port;
    }

    /**
     * Return the protocol type
     *
     * @return Rpc.ProtocolId
     */
    public final Rpc.ProtocolId isProtocol() {
        return m_protocol;
    }

    /**
     * Send an RPC request to the server
     *
     * @param rpc   RpcPacket
     * @param rxRpc RpcPacket
     * @return RpcPacket
     * @exception IOException Socket error
     */
    public abstract RpcPacket sendRPC(RpcPacket rpc, RpcPacket rxRpc)
            throws IOException;

    /**
     * Close the connection to the remote RPC server
     */
    public abstract void closeConnection();

    /**
     * Return the RPC connection details as a string
     *
     * @return String
     */
    public String toString() {
        StringBuffer str = new StringBuffer();

        str.append("[");
        str.append(isProtocol().name());
        str.append(getServerAddress().getHostAddress());
        str.append(":");
        str.append(getServerPort());

        str.append(",");
        str.append(getMaximumRpcSize());
        str.append("]");

        return str.toString();
    }
}