jadex.bridge.component.IRemoteCommand 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;

import jadex.bridge.IInternalAccess;
import jadex.bridge.service.types.security.ISecurityInfo;
import jadex.commons.future.IFuture;

/**
 *  Interface for remotely executable commands.
 */
public interface IRemoteCommand
{
	/**
	 *  Execute a command.
	 *  @param access The agent that is running the command.
	 *  @param secinf The established security level to e.g. decide if the command is allowed.
	 *  @return A future for return value(s). May also be intermediate, subscription, etc.
	 */
	public IFuture	execute(IInternalAccess access, ISecurityInfo secinf);
	
	/**
	 *  Checks if the remote command is internally valid.
	 * 
	 *  @param access The component access.
	 *  @return Exception describing the error if invalid.
	 */
	public Exception isValid(IInternalAccess access);
}