EventSource.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.event;

import java.io.Serializable;
import java.util.HashSet;
import java.util.Set;

import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.OneToMany;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;

import org.jetbrains.annotations.NotNull;

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

/**
 * An event source (e.g. a log file path or an SNMP trap OID) for a specific type of {@link Event} (see
 * {@link EventDefinition}) and a specific {@link org.rhq.core.domain.resource.Resource}.
 *
 * @author Ian Springer
 */
@Entity
@NamedQueries( {
    @NamedQuery(name = EventSource.QUERY_DELETE_BY_RESOURCES, query = "DELETE FROM EventSource evs WHERE evs.resource.id IN ( :resourceIds ) "),
    @NamedQuery(name = EventSource.QUERY_BY_EVENT_DEFINITION, query = "SELECT evs FROM EventSource evs WHERE evs.eventDefinition = :definition") })
@Table(name = EventSource.TABLE_NAME)
@SequenceGenerator(allocationSize = org.rhq.core.domain.util.Constants.ALLOCATION_SIZE, name = EventSource.TABLE_NAME
    + "_ID_SEQ", sequenceName = EventSource.TABLE_NAME + "_ID_SEQ")
public class EventSource implements Serializable {
    private static final long serialVersionUID = 1L;

    public static final String TABLE_NAME = "RHQ_EVENT_SOURCE";
    public static final String QUERY_DELETE_BY_RESOURCES = "EventSource.deleteByResources";
    public static final String QUERY_BY_EVENT_DEFINITION = "EventSource.deletebyEventDefinition";

    @Id
    @Column(name = "ID", nullable = false)
    @GeneratedValue(strategy = GenerationType.AUTO, generator = EventSource.TABLE_NAME + "_ID_SEQ")
    private int id;

    @JoinColumn(name = "EVENT_DEF_ID", nullable = false)
    @ManyToOne
    private EventDefinition eventDefinition;

    @JoinColumn(name = "RESOURCE_ID", nullable = false)
    @ManyToOne(fetch = FetchType.LAZY, optional = false)
    private Resource resource;

    @Column(name = "RESOURCE_ID", insertable = false, updatable = false)
    private int resourceId;

    @Column(name = "LOCATION", length = 2000, nullable = false)
    private String location;

    @OneToMany(mappedBy = "source", cascade = { CascadeType.REMOVE }, fetch = FetchType.LAZY)
    private Set<Event> events = new HashSet<Event>();

    /* no-arg constructor required by EJB spec and Externalizable (Externalizable also requires it to be public) */
    public EventSource() {
    }

    public EventSource(@NotNull String location, @NotNull EventDefinition eventDefinition, @NotNull Resource resource) {
        if (location == null)
            throw new IllegalArgumentException("location parameter must not be null.");
        if (eventDefinition == null)
            throw new IllegalArgumentException("eventDefinition parameter must not be null.");
        if (resource == null)
            throw new IllegalArgumentException("resource parameter must not be null.");
        this.location = location;
        this.eventDefinition = eventDefinition;
        this.resource = resource;
        this.resourceId = this.resource.getId();
    }

    public int getId() {
        return this.id;
    }

    public EventDefinition getEventDefinition() {
        return eventDefinition;
    }

    public Resource getResource() {
        return resource;
    }

    public int getResourceId() {
        return resourceId;
    }

    @NotNull
    public String getLocation() {
        return this.location;
    }

    public Set<Event> getEvents() {
        return events;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null || !(obj instanceof EventSource))
            return false;

        EventSource that = (EventSource) obj;

        if (!eventDefinition.equals(that.eventDefinition))
            return false;
        if (resourceId != that.resourceId)
            return false;
        if (!location.equals(that.location))
            return false;

        return true;
    }

    @Override
    public int hashCode() {
        int result;
        result = eventDefinition.hashCode();
        result = 31 * result + resourceId;
        result = 31 * result + location.hashCode();
        return result;
    }

    @Override
    public String toString() {
        return this.getClass().getName().substring(this.getClass().getName().lastIndexOf(".") + 1) + "[" + "id="
            + this.id + ", " + "eventDefinition.name="
            + ((this.eventDefinition != null) ? this.eventDefinition.getName() : "null") + ", " + "resource.name="
            + ((this.resource != null) ? this.resource.getName() : "null") + ", " + "location=" + this.location + "]";

    }
}