net.powermatcher.core

Class BaseAgentEndpoint

java.lang.Object

net.powermatcher.core.BaseAgent

net.powermatcher.core.BaseAgentEndpoint

All Implemented Interfaces:

Agent, AgentEndpoint, ObservableAgent

Direct Known Subclasses:

Concentrator

public abstract class BaseAgentEndpoint
extends BaseAgent
implements AgentEndpoint

BaseAgentEndpoint defines the basic functionality of any Device Agent.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseAgentEndpoint.Connected The BaseAgentEndpoint.Connected object describes the current status and configuration of an AgentEndpoint.

Nested classes/interfaces inherited from interface net.powermatcher.api.AgentEndpoint

AgentEndpoint.Status

Field Summary

Fields

Modifier and Type	Field and Description
static AgentEndpoint.Status	NOT_CONNECTED

Fields inherited from class net.powermatcher.core.BaseAgent

context, LOGGER

Constructor Summary

Constructors

Constructor and Description
BaseAgentEndpoint()

Method Summary

Methods

Modifier and Type	Method and Description
void	connectToMatcher(Session session) Connects this AgentEndpoint instance to a MatcherEndpoint.
void	deactivate()
java.lang.String	getAgentId()
java.lang.String	getDesiredParentId()
BidUpdate	getLastBidUpdate()
AgentEndpoint.Status	getStatus()
void	handlePriceUpdate(PriceUpdate priceUpdate) Called by MatcherEndpoint via the Session to update the Price used by this AgentEndpoint instance.
protected void	init(java.lang.String agentId, java.lang.String desiredParentId) This method should always be called during activation of the agent.
void	matcherEndpointDisconnected(Session session) Notifies the Agent that this AgentEndpoint instance is disconnected from the MatcherEndpoint.
protected BidUpdate	publishBid(Bid newBid) Publishes a new bid to its matcher by creating a new BidUpdate using a generated bidnumber.

Methods inherited from class net.powermatcher.core.BaseAgent

addObserver, now, publishEvent, removeObserver, setContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.powermatcher.api.Agent

setContext

Field Detail

NOT_CONNECTED

public static final AgentEndpoint.Status NOT_CONNECTED

Constructor Detail

BaseAgentEndpoint

public BaseAgentEndpoint()

Method Detail

getAgentId

public java.lang.String getAgentId()

Specified by:

getAgentId in interface Agent

Returns:

the mandatory unique id of the Agent.

getDesiredParentId

public java.lang.String getDesiredParentId()

Specified by:

getDesiredParentId in interface AgentEndpoint

Returns:

the id of the desired parent Agent.

getStatus

public AgentEndpoint.Status getStatus()

Specified by:

getStatus in interface Agent

Specified by:

getStatus in interface AgentEndpoint

Returns:

The current Agent.Status of the Agent. This returns a snapshot of the state that won't change. If used at a later time, the snapshot should be refreshed.

init

protected void init(java.lang.String agentId,
        java.lang.String desiredParentId)

This method should always be called during activation of the agent. It sets the agentId and desiredParentId.

Parameters:

agentId - The agentId that should be used by this BaseAgent. This will be returned when the getAgentId() is called.

desiredParentId - The agentId that should be used by this BaseAgentEndpoint when determining the desired parent. This will be returned when the getDesiredParentId() is called.

Throws:

java.lang.IllegalArgumentException - when either the agentId or the desiredParentId is null or is an empty string.

connectToMatcher

public void connectToMatcher(Session session)

Connects this AgentEndpoint instance to a MatcherEndpoint.

Specified by:

connectToMatcher in interface AgentEndpoint

Parameters:

session - the Session that will link this AgentEndpoint with a MatcherEndpoint.

matcherEndpointDisconnected

public void matcherEndpointDisconnected(Session session)

Notifies the Agent that this AgentEndpoint instance is disconnected from the MatcherEndpoint.

Specified by:

matcherEndpointDisconnected in interface AgentEndpoint

Parameters:

session - the Session that used to link the MatcherEndpoint with this AgentEndpoint.

deactivate

public void deactivate()

getLastBidUpdate

public final BidUpdate getLastBidUpdate()

Returns:

the current value of lastBid.

publishBid

protected final BidUpdate publishBid(Bid newBid)

Publishes a new bid to its matcher by creating a new BidUpdate using a generated bidnumber. The call will be ignored if the Agent is not connected.

Parameters:

newBid - The new bid that is to be sent to the connected matcher

Returns:

The BidUpdate that has been set or null if not connected.

handlePriceUpdate

public void handlePriceUpdate(PriceUpdate priceUpdate)

Called by MatcherEndpoint via the Session to update the Price used by this AgentEndpoint instance. This base implementation checks if the PriceUpdate is valid and publishes the IncomingPriceUpdateEvent.

Specified by:

handlePriceUpdate in interface AgentEndpoint

Parameters:

priceUpdate - The new Price, wrapped in a PriceUpdate, along with the id of the Bid it was based on.