net.powermatcher.core

Class BaseMatcherEndpoint

java.lang.Object

net.powermatcher.core.BaseAgent

net.powermatcher.core.BaseMatcherEndpoint

All Implemented Interfaces:

Agent, MatcherEndpoint, ObservableAgent

Direct Known Subclasses:

Auctioneer

public abstract class BaseMatcherEndpoint
extends BaseAgent
implements MatcherEndpoint

Nested Class Summary

Nested Classes

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

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

Agent.Status

Field Summary

Fields

Modifier and Type	Field and Description
static Agent.Status	NOT_CONNECTED

Fields inherited from class net.powermatcher.core.BaseAgent

context, LOGGER

Constructor Summary

Constructors

Constructor and Description
BaseMatcherEndpoint()

Method Summary

Methods

Modifier and Type	Method and Description
void	agentEndpointDisconnected(Session session) Notifies the Agent that this MatcherEndpoint instance is disconnected from the AgentEndpoint.
AggregatedBid	aggregate()
void	configure(MarketBasis marketBasis, java.lang.String clusterId, long minTimeBetweenUpdates)
void	connectToAgent(Session session) Connects this MatcherEndpoint instance to an AgentEndpoint.
java.lang.String	getAgentId()
Agent.Status	getStatus()
void	handleBidUpdate(Session session, BidUpdate bidUpdate) Called by the AgentEndpoint via the Session to update the Bid used by this AgentEndpoint instance.
protected void	init(java.lang.String agentId) This method should always be called during activation of the agent.
protected abstract void	performUpdate(AggregatedBid aggregatedBid)
void	publishPrice(Price price, AggregatedBid aggregatedBid)
void	unconfigure()

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 Agent.Status NOT_CONNECTED

Constructor Detail

BaseMatcherEndpoint

public BaseMatcherEndpoint()

Method Detail

getAgentId

public java.lang.String getAgentId()

Specified by:

getAgentId in interface Agent

Returns:

the mandatory unique id of the Agent.

getStatus

public Agent.Status getStatus()

Specified by:

getStatus in interface Agent

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)

This method should always be called during activation of the agent. It sets the agentId and desiredParentId. This will also call the init(String) method, so that call is no longer needed.

Parameters:

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

Throws:

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

configure

public void configure(MarketBasis marketBasis,
             java.lang.String clusterId,
             long minTimeBetweenUpdates)

unconfigure

public void unconfigure()

connectToAgent

public void connectToAgent(Session session)

Description copied from interface: MatcherEndpoint

Connects this MatcherEndpoint instance to an AgentEndpoint.

Specified by:

connectToAgent in interface MatcherEndpoint

Parameters:

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

agentEndpointDisconnected

public void agentEndpointDisconnected(Session session)

Description copied from interface: MatcherEndpoint

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

Specified by:

agentEndpointDisconnected in interface MatcherEndpoint

Parameters:

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

publishPrice

public void publishPrice(Price price,
                AggregatedBid aggregatedBid)

aggregate

public final AggregatedBid aggregate()

performUpdate

protected abstract void performUpdate(AggregatedBid aggregatedBid)

handleBidUpdate

public void handleBidUpdate(Session session,
                   BidUpdate bidUpdate)

Description copied from interface: MatcherEndpoint

Called by the AgentEndpoint via the Session to update the Bid used by this AgentEndpoint instance.

Specified by:

handleBidUpdate in interface MatcherEndpoint

Parameters:

session - The session linking this MatcherEndpoint with a specific AgentEndpoint instance.

bidUpdate - The new BidUpdate.