AgentLastAvailabilityPingComposite.java

/*
 * RHQ Management Platform
 * Copyright (C) 2005-2008 Red Hat, Inc.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2, as
 * published by the Free Software Foundation, and/or the GNU Lesser
 * General Public License, version 2.1, also as published by the Free
 * Software Foundation.
 *
 * This program 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 General Public License and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with this program;
 * if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.rhq.core.domain.resource.composite;

import java.io.Serializable;

import org.rhq.core.domain.resource.Agent;

/**
 * Pairs an {@link Agent} with its {@link Agent#getLastAvailabilityReport() last report time}. The purpose of this is so
 * we can query the database for all agents and only have to keep in memory just the things we'll need initially, that
 * is the last available time and the agent ID.
 *
 * @author John Mazzitelli
 */
public class AgentLastAvailabilityPingComposite implements Serializable {

    private static final long serialVersionUID = 1L;

    private final int agentId;
    private final String agentName;
    private final String remoteEndpoint;
    private final Long lastAvailabilityPing;
    private final boolean backFilled;

    public AgentLastAvailabilityPingComposite(int agentId, String agentName, String remoteEndpoint, Long lastPing,
        boolean backFilled) {
        this.agentId = agentId;
        this.agentName = agentName;
        this.remoteEndpoint = remoteEndpoint;
        this.lastAvailabilityPing = lastPing;
        this.backFilled = backFilled;
    }

    public int getAgentId() {
        return agentId;
    }

    public String getAgentName() {
        return agentName;
    }

    public String getRemoteEndpoint() {
        return remoteEndpoint;
    }

    public Long getLastAvailabilityPing() {
        return lastAvailabilityPing;
    }

    public boolean isBackFilled() {
        return backFilled;
    }

    @Override
    public int hashCode() {
        return this.agentId;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }

        if ((obj == null) || (!(obj instanceof AgentLastAvailabilityPingComposite))) {
            return false;
        }

        return (this.agentId == ((AgentLastAvailabilityPingComposite) obj).agentId);
    }

    @Override
    public String toString() {
        return "AgentLastAvailableReportComposite: id=[" + this.agentId + "], name=[" + this.agentName
            + "], remote-endpoint=[" + this.remoteEndpoint + "], last-report=[" + this.lastAvailabilityPing
            + "], back-filled=[" + this.backFilled + "]";
    }
}