jadex.bridge.component.IMsgHeader Maven / Gradle / Ivy

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.IComponentIdentifier;

/**
 *   Interface for message headers with meta information / link-level security.
 *
 */
public interface IMsgHeader
{
	/** Message header key for the sender. */
	public static final String SENDER = "sender";
	
	/** Message header key for the receiver. */
	public static final String RECEIVER = "receiver";
	
	/** Message header key for conversation IDs (optional). */
	public static final String CONVERSATION_ID = "convid";

	/** Message header key for internal message id (optional).
	 *  Added automatically when monitoring is active on sender side. */
	public static final String XID = "x_message_id";
	
	/**
	 *  Gets the sender of the message.
	 * 
	 *  @return The sender.
	 */
	public IComponentIdentifier getSender();
	
	/**
	 *  Gets the receiver of the message.
	 * 
	 *  @return The receiver.
	 */
	public IComponentIdentifier getReceiver();
	
	/**
	 *  Gets a property stored in the header.
	 *  
	 *  @param propertyname
	 * @return
	 */
	public Object getProperty(String propertyname);
	
	/**
	 *  Adds a header property to the header.
	 *  
	 *  @param propname The property name.
	 *  @param propval The property value.
	 */
	public void addProperty(String propname, Object propval);
}