org.filesys.server.auth.passthru.PassthruServerDetails 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.server.auth.passthru;

import java.net.InetAddress;
import java.util.Date;

/**
 * Contains the details of a server used for passthru authentication, the current status of the server
 * and count of authentications done via this server.
 *
 * @author GKSpencer
 */
public class PassthruServerDetails {
    // Server details
    private String m_name;
    private String m_domain;
    private InetAddress m_address;

    // Server status
    private boolean m_online;

    // Authentication statistics
    private int m_authCount;
    private long m_lastAuthTime;

    /**
     * Class constructor
     *
     * @param name   String
     * @param domain String
     * @param addr   InetAddress
     * @param online boolean
     */
    PassthruServerDetails(String name, String domain, InetAddress addr, boolean online) {
        m_name = name;
        m_domain = domain;
        m_address = addr;
        m_online = online;
    }

    /**
     * Return the server name
     *
     * @return String
     */
    public final String getName() {
        return m_name;
    }

    /**
     * Return the domain name
     *
     * @return String
     */
    public final String getDomain() {
        return m_domain;
    }

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

    /**
     * Return the online status of the server
     *
     * @return boolean
     */
    public final boolean isOnline() {
        return m_online;
    }

    /**
     * Return the authentication count for the server
     *
     * @return int
     */
    public final int getAuthenticationCount() {
        return m_authCount;
    }

    /**
     * Return the date/time of the last authentication by this server
     *
     * @return long
     */
    public final long getAuthenticationDateTime() {
        return m_lastAuthTime;
    }

    /**
     * Set the domain that the offline server belongs to
     *
     * @param domain String
     */
    public final void setDomain(String domain) {
        m_domain = domain;
    }

    /**
     * Set the online status for the server
     *
     * @param online boolean
     */
    public final void setOnline(boolean online) {
        m_online = online;
    }

    /**
     * Update the authentication count and date/time
     */
    public synchronized final void incrementAuthenticationCount() {
        m_authCount++;
        m_lastAuthTime = System.currentTimeMillis();
    }

    /**
     * Return the hash code for this object
     *
     * @return int
     */
    public int hashCode() {
        return m_address.hashCode();
    }

    /**
     * Return the passthru server details as a string
     *
     * @return String
     */
    public String toString() {
        StringBuilder str = new StringBuilder();

        str.append("[");
        if (getDomain() != null) {
            str.append(getDomain());
            str.append("\\");
        }
        str.append(getName());

        str.append(":");
        str.append(getAddress().getHostAddress());

        str.append(isOnline() ? ":Online" : ":Offline");

        str.append(":");
        str.append(getAuthenticationCount());
        str.append(",");
        str.append(getAuthenticationDateTime() != 0L ? new Date(getAuthenticationDateTime()).toString() : "0");
        str.append("]");

        return str.toString();
    }
}