ApsEvent.java

/*
*
* Copyright 2005 AgileTec s.r.l. (http://www.agiletec.it) All rights reserved.
*
* This file is part of jAPS software.
* jAPS is a free software; 
* you can redistribute it and/or modify it
* under the terms of the GNU General Public License (GPL) as published by the Free Software Foundation; version 2.
* 
* See the file License for the specific language governing permissions   
* and limitations under the License
* 
* 
* 
* Copyright 2005 AgileTec s.r.l. (http://www.agiletec.it) All rights reserved.
*
*/
package com.agiletec.aps.system.common.notify;

import org.springframework.context.ApplicationEvent;

import com.agiletec.aps.system.common.IManager;

/**
 * Base class for the implementation of the events to be notified to the event management
 * service.
 * The class that implements the event must exclusively know the interface through which the
 * observing service (the final destination of the notification) must implement to properly handle
 * the specific event.
 * @author M.Diana - E.Santoboni
 */
public abstract class ApsEvent extends ApplicationEvent {
	
	/**
	 * Event constructor
	 */
	public ApsEvent() {
		super("jAPS Event");
		this.setSource(LOCAL_EVENT);
	}
	
	/**
	 * Notify the event to the observer service. This method must be invoked 
	 * inside the update() method of the observer service. 
	 * @param srv The listening service
	 */
	public abstract void notify(IManager srv);
	
	/**
	 * Return the object class of the interface that the observer service  have to implement
	 * to handle to event.
	 * @return The interface class which the observer must implement 
	 */
	public abstract Class getObserverInterface();

	/**
	 * Return the source of the event. 
	 * The property can be a IP address, an host name, or else.
	 * @return The source of the event.
	 */
	public String getSource() {
		return _source;
	}
	
	/**
	 * Set the source of the event.
	 * @param source The source of the event to set.
	 */
	public void setSource(String source) {
		this._source = source;
	}
	
	private String _source;
	
	/**
	 * The default source event.
	 */
	public static final String LOCAL_EVENT = "localhost";
	
}