org.filesys.oncrpc.PortMapping 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;

/**
 * Port Details Class
 *
 * Contains the details of an RPC service registered with the PortMapper service.
 *
 * @author gkspencer
 */
public class PortMapping {

    //	Program id and version
    private int m_programId;
    private int m_versionId;

    //	Protocol type (UDP or TCP)
    private Rpc.ProtocolId m_protocol;

    //	Port
    private int m_port;

    /**
     * Class constructor
     *
     * @param progId   int
     * @param verId    int
     * @param protocol Rpc.ProtocolId
     * @param port     int
     */
    public PortMapping(int progId, int verId, Rpc.ProtocolId protocol, int port) {
        m_programId = progId;
        m_versionId = verId;
        m_protocol = protocol;
        m_port = port;
    }

    /**
     * Return the program id
     *
     * @return int
     */
    public final int getProgramId() {
        return m_programId;
    }

    /**
     * Return the version id
     *
     * @return int
     */
    public final int getVersionId() {
        return m_versionId;
    }

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

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

    /**
     * Return a hash code for the port mapping
     *
     * @return int
     */
    public int hashCode() {

        //	Create a hash code from the program id + version + protocol
        return generateHashCode(m_programId, m_versionId, m_protocol.ordinal());
    }

    /**
     * Generate a hash code for the specified program, version and protocol
     *
     * @param progId int
     * @param verId  int
     * @param proto  int
     * @return int
     */
    public final static int generateHashCode(int progId, int verId, int proto) {

        //	Create a hash code from the program id + version + protocol
        return (progId << 16) + (verId << 8) + proto;
    }

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

        str.append("[");
        str.append(getProgramId());
        str.append(":");
        str.append(getVersionId());
        str.append(getProtocol().name());
        str.append(getPort());
        str.append("]");

        return str.toString();
    }
}