com.almende.eve.agent.example.EchoAgent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eve-core Show documentation

There is a newer version: 3.1.1

/**
 * @file EchoAgent.java
 * 
 * @brief
 *        TODO: brief
 * 
 * @license
 *          Licensed under the Apache License, Version 2.0 (the "License"); you
 *          may not
 *          use this file except in compliance with the License. You may obtain
 *          a copy
 *          of the License at
 * 
 *          http://www.apache.org/licenses/LICENSE-2.0
 * 
 *          Unless required by applicable law or agreed to in writing, software
 *          distributed under the License is distributed on an "AS IS" BASIS,
 *          WITHOUT
 *          WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
 *          the
 *          License for the specific language governing permissions and
 *          limitations under
 *          the License.
 * 
 *          Copyright © 2010-2011 Almende B.V.
 * 
 * @author Jos de Jong, 
 * @date 2011-03-05
 */
package com.almende.eve.agent.example;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import com.almende.eve.agent.Agent;
import com.almende.eve.rpc.annotation.Access;
import com.almende.eve.rpc.annotation.AccessType;
import com.almende.eve.rpc.annotation.Name;

/**
 * The Class EchoAgent.
 */
@Access(AccessType.PUBLIC)
public class EchoAgent extends Agent {
	
	/**
	 * Ping.
	 *
	 * @param message the message
	 * @return the object
	 * @throws IOException Signals that an I/O exception has occurred.
	 */
	public Object ping(@Name("message") final Object message) throws IOException {
		// trigger event
		final Map params = new HashMap();
		params.put("message", message);
		getEventsFactory().trigger("ping", params);
		
		// return the message itself
		return message;
	}
	
	/* (non-Javadoc)
	 * @see com.almende.eve.agent.Agent#getVersion()
	 */
	@Override
	public String getVersion() {
		return "1.0";
	}
	
	/* (non-Javadoc)
	 * @see com.almende.eve.agent.Agent#getDescription()
	 */
	@Override
	public String getDescription() {
		return "This agent can be used for test purposes. "
				+ "It contains a simple ping method.";
	}
}