genius.core.protocol

Class DefaultMultilateralProtocol

java.lang.Object

genius.core.protocol.DefaultMultilateralProtocol

All Implemented Interfaces:

MultilateralProtocol

Direct Known Subclasses:

AlternatingMultipleOffersProtocol, MediatorProtocol, StackedAlternatingOffersProtocol

public class DefaultMultilateralProtocol
extends java.lang.Object
implements MultilateralProtocol

An adapter for the protocol class. This implements default functionality for the methods in the Protocol interface and return default values for them.

Author:

David Festen

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isAborted

Constructor Summary

Constructors

Constructor and Description
DefaultMultilateralProtocol()

Method Summary

Modifier and Type	Method and Description
void	afterSession(Session session, java.util.List<NegotiationParty> parties) This will get called just after ending the session.
void	applyAction(Action action, Session session) Apply the action according to the protocol.
java.util.Map<NegotiationParty,java.util.List<Action>>	beforeSession(Session session, java.util.List<NegotiationParty> parties) Returns a list of Actions to be sent to NegotiationParty.receiveMessage(AgentID, Action) .
protected void	checkOffer(Offer offer) Check incoming offer
void	endNegotiation() Overwrites the rest of the protocol and sets the protocol state to finish
void	endNegotiation(java.lang.String reason) Overwrites the rest of the protocol and sets the protocol state to finish
java.util.Collection<NegotiationParty>	exclude(java.util.Collection<NegotiationParty> negotiationParties, java.lang.Class negotiationPartyClass) Filters the list by including only the type of negotiation parties.
java.util.Map<NegotiationParty,java.util.List<NegotiationParty>>	getActionListeners(java.util.List<NegotiationParty> parties) Get a map of parties that are listening to each other's response
Bid	getCurrentAgreement(Session session, java.util.List<NegotiationParty> parties) This method should return the current agreement.
int	getNumberOfAgreeingParties(Session session, java.util.List<NegotiationParty> parties) Gets the number of parties that currently agree to the offer.
Round	getRoundStructure(java.util.List<NegotiationParty> parties, Session session) Get the structure of the current round.
java.util.Collection<NegotiationParty>	includeOnly(java.util.Collection<NegotiationParty> negotiationParties, java.lang.Class negotiationPartyClass) Filters the list by including only the type of negotiation parties.
boolean	isFinished(Session session, java.util.List<NegotiationParty> parties) Check if the protocol is done or still busy.
protected static java.util.Map<NegotiationParty,java.util.List<NegotiationParty>>	listenToAll(java.util.List<NegotiationParty> parties)
protected static java.util.Map<NegotiationParty,java.util.List<NegotiationParty>>	listenToNone(java.util.List<NegotiationParty> parties)

Methods inherited from class java.lang.Object

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

Field Detail

isAborted

protected boolean isAborted

Constructor Detail

DefaultMultilateralProtocol

public DefaultMultilateralProtocol()

Method Detail

getRoundStructure

public Round getRoundStructure(java.util.List<NegotiationParty> parties,
                               Session session)

Description copied from interface: MultilateralProtocol

Get the structure of the current round. Each round, this method receives a list of all the NegotiationParty and the complete Session which can be used to diversify the round structure at some point during the session.

Specified by:

getRoundStructure in interface MultilateralProtocol

Parameters:

parties - The parties currently participating

session - The complete session history

Returns:

A list of possible actions

beforeSession

public java.util.Map<NegotiationParty,java.util.List<Action>> beforeSession(Session session,
                                                                            java.util.List<NegotiationParty> parties)
                                                                     throws NegotiationPartyTimeoutException,
                                                                            java.util.concurrent.ExecutionException,
                                                                            java.lang.InterruptedException

Description copied from interface: MultilateralProtocol

Returns a list of Actions to be sent to NegotiationParty.receiveMessage(AgentID, Action) . This will get called just before the session starts. If some initialization with needs to be done by the protocol, it can be done here.

Specified by:

beforeSession in interface MultilateralProtocol

Parameters:

session - The upcoming Session

parties - The NegotiationPartys that will participate in the session

Throws:

NegotiationPartyTimeoutException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

afterSession

public void afterSession(Session session,
                         java.util.List<NegotiationParty> parties)

Description copied from interface: MultilateralProtocol

This will get called just after ending the session. If the protocol needs to do some post session steps, it can be done here. Protocols should not handle NegotiationParty.negotiationEnded(Bid) as these are always called by the SessionManager.

Specified by:

afterSession in interface MultilateralProtocol

Parameters:

session - The session instance that was used for the session

parties - The parties that participated in the session

applyAction

public void applyAction(Action action,
                        Session session)
                 throws ActionException

Description copied from interface: MultilateralProtocol

Apply the action according to the protocol. All actions done by all agents come through this method. The protocol should check here if the agent's action is actually allowed and contains the proper data.

Specified by:

applyAction in interface MultilateralProtocol

Parameters:

action - action to apply. The Agent ID in the action already has been checked when this is called.

session - the current state of this session

Throws:

ActionException - if the proposed action is illegal according to the protocol.

checkOffer

protected void checkOffer(Offer offer)
                   throws ActionException

Check incoming offer

Parameters:

action - the offer

Throws:

ActionException

isFinished

public boolean isFinished(Session session,
                          java.util.List<NegotiationParty> parties)

Description copied from interface: MultilateralProtocol

Check if the protocol is done or still busy. If this method returns true, the SessionManager will not start a new Round after the current one. It will however finish all the turns described in the MultilateralProtocol.getRoundStructure(java.util.List, genius.core.session.Session) method.

Specified by:

isFinished in interface MultilateralProtocol

Parameters:

session - the current state of this session

parties - all the parties involved in the negotiation

Returns:

true if the protocol is finished

getActionListeners

public java.util.Map<NegotiationParty,java.util.List<NegotiationParty>> getActionListeners(java.util.List<NegotiationParty> parties)

Get a map of parties that are listening to each other's response

Specified by:

getActionListeners in interface MultilateralProtocol

Parameters:

parties - The parties involved in the current negotiation

Returns:

A map where the key is a NegotiationParty that is responding to a NegotiationParty.chooseAction(java.util.List) event, and the value is a list of NegotiationParty that are listening to that key party's response.

getCurrentAgreement

public Bid getCurrentAgreement(Session session,
                               java.util.List<NegotiationParty> parties)

This method should return the current agreement.

Some protocols only have an agreement at the negotiation session, make sure that this method returns null until the end of the session in that case, because this method might be queried at intermediary steps.

Specified by:

getCurrentAgreement in interface MultilateralProtocol

Parameters:

session - The complete session history up to this point

parties - The parties involved in the current negotiation

Returns:

The agreed upon bid or null if no agreement

getNumberOfAgreeingParties

public int getNumberOfAgreeingParties(Session session,
                                      java.util.List<NegotiationParty> parties)

Gets the number of parties that currently agree to the offer.

Default implementation returns 0 if no agreement or number of parties if agreement exists.

Specified by:

getNumberOfAgreeingParties in interface MultilateralProtocol

Parameters:

session - the current state of this session

parties - The parties currently participating

Returns:

the number of parties agreeing to the current agreement

includeOnly

public java.util.Collection<NegotiationParty> includeOnly(java.util.Collection<NegotiationParty> negotiationParties,
                                                          java.lang.Class negotiationPartyClass)

Filters the list by including only the type of negotiation parties. Optionally, this behavior can be reversed (i.e. excluding only the given type of negotiation parties).

Parameters:

negotiationParties - The original list of parties

negotiationPartyClass - The type of parties to include

Returns:

The filtered list of parties

exclude

public java.util.Collection<NegotiationParty> exclude(java.util.Collection<NegotiationParty> negotiationParties,
                                                      java.lang.Class negotiationPartyClass)

Filters the list by including only the type of negotiation parties. Optionally, this behavior can be reversed (i.e. excluding only the given type of negotiation parties).

Parameters:

negotiationParties - The original list of parties

negotiationPartyClass - The type of parties to include

Returns:

The filtered list of parties

endNegotiation

public void endNegotiation()

Overwrites the rest of the protocol and sets the protocol state to finish

Specified by:

endNegotiation in interface MultilateralProtocol

endNegotiation

public void endNegotiation(java.lang.String reason)

Overwrites the rest of the protocol and sets the protocol state to finish

Specified by:

endNegotiation in interface MultilateralProtocol

Parameters:

reason - Optionally give a reason why the protocol is finished.

listenToAll

protected static java.util.Map<NegotiationParty,java.util.List<NegotiationParty>> listenToAll(java.util.List<NegotiationParty> parties)

Parameters:

parties - all the parties in the negotiation

Returns:

map with as keys all NegotiationParty and as values for each key all other NegotiationPartys.

listenToNone

protected static java.util.Map<NegotiationParty,java.util.List<NegotiationParty>> listenToNone(java.util.List<NegotiationParty> parties)

Parameters:

parties - all the parties in the negotiation

Returns:

map with as keys all NegotiationParty and as values an empty list.