jadex.bridge.component.impl.remotecommands.RemoteTerminationCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jadex-platform-bridge Show documentation

Jadex bridge is a base package for kernels and platforms, i.e., it is used by both and provides commonly used interfaces and classes for active components and their management.

There is a newer version: 4.0.267

Show newest version

package jadex.bridge.component.impl.remotecommands;

import jadex.bridge.IInternalAccess;
import jadex.bridge.component.impl.IRemoteConversationCommand;
import jadex.bridge.service.types.security.ISecurityInfo;
import jadex.commons.future.IFuture;
import jadex.commons.future.ITerminableFuture;

/**
 *  Command for future termmination.
 */
public class RemoteTerminationCommand implements IRemoteConversationCommand
{
	/** The termination reason (if any). */
	protected Exception reason;
	
	/**
	 *  Create the command.
	 */
	public RemoteTerminationCommand()
	{
	}
	
	/**
	 *  Create the command.
	 */
	public RemoteTerminationCommand(Exception reason)
	{
		this.reason = reason;
	}
	
	/**
	 *  Execute a command.
	 *  @param access The agent to run the command on.
	 *  @param future Future of the active conversation.
	 *  @param secinf The established security level to decide if the command is allowed.
	 */
	public void	execute(IInternalAccess access, IFuture future, ISecurityInfo secinf)
	{
		if (reason!=null)
		{
			((ITerminableFuture)future).terminate(reason);
		}
		else
		{
			((ITerminableFuture)future).terminate();
		}
	}
	
	/**
	 *  Get the reason.
	 *  @return The reason.
	 */
	public Exception getReason()
	{
		return reason;
	}

	/**
	 *  Set the reason.
	 *  @param reason The reason to set.
	 */
	public void setReason(Exception reason)
	{
		this.reason = reason;
	}
	
}