Package com.tnsai.protocols.fipa

Class ProposeProtocol

java.lang.Object

com.tnsai.protocols.fipa.ProposeProtocol

All Implemented Interfaces:

ConversationProtocol

public class ProposeProtocol
extends Object
implements ConversationProtocol

FIPA Propose Interaction Protocol.

Implements a negotiation pattern where an initiator proposes an action/agreement and the responder can accept or reject.

Protocol Flow

 Initiator                    Responder
     |                            |
     |--- PROPOSE --------------->|
     |                            |
     |invalid input: '<'-- ACCEPT-PROPOSAL --------|
     |    or REJECT-PROPOSAL      |
     |                            |
 

Nested Class Summary

Nested classes/interfaces inherited from interface com.tnsai.protocols.fipa.ConversationProtocol

ConversationProtocol.ProtocolState

Constructor Summary

Constructors

Constructor	Description
ProposeProtocol()

Method Summary

Modifier and Type	Method	Description
FIPAMessage	createAccept(FIPAMessage proposal, String reason)	Creates an accept response.
FIPAMessage	createInitialMessage(String sender, String receiver, String content)	Creates the initial message for this protocol.
FIPAMessage	createReject(FIPAMessage proposal, String reason)	Creates a reject response.
FIPAMessage	createResponse(FIPAMessage original, FIPAPerformative performative, String content)	Creates a response to a message.
String	getDescription()	Gets the protocol description.
Set<FIPAPerformative>	getInitiatingPerformatives()	Gets valid initiating performatives for this protocol.
List<FIPAMessage>	getMessageHistory()	Gets message history for this conversation.
String	getName()	Gets the protocol name.
Optional<String>	getResult()	Gets the final result if available.
ConversationProtocol.ProtocolState	getState()	Gets the current protocol state.
List<String>	getValidationErrors(FIPAMessage message)	Gets validation errors for a message.
Set<FIPAPerformative>	getValidResponses(FIPAPerformative initiator)	Gets valid response performatives for a given initiator.
boolean	isComplete()	Checks if protocol is complete.
boolean	isSuccessful()	Checks if protocol succeeded.
boolean	isValidMessage(FIPAMessage message)	Validates if a message is valid for this protocol.
boolean	isValidResponse(FIPAMessage request, FIPAMessage response)	Validates if a response is valid for a given request.
void	processMessage(FIPAMessage message)	Processes an incoming message and updates state.
void	reset()	Resets the protocol for reuse.

Methods inherited from class java.lang.Object

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

Constructor Details

ProposeProtocol

public ProposeProtocol()

Method Details

getName

public String getName()

Description copied from interface: ConversationProtocol

Gets the protocol name.

Specified by:

getName in interface ConversationProtocol

Returns:

protocol identifier (e.g., "fipa-request")

getDescription

public String getDescription()

Description copied from interface: ConversationProtocol

Gets the protocol description.

Specified by:

getDescription in interface ConversationProtocol

Returns:

human-readable description

getInitiatingPerformatives

public Set<FIPAPerformative> getInitiatingPerformatives()

Description copied from interface: ConversationProtocol

Gets valid initiating performatives for this protocol.

Specified by:

getInitiatingPerformatives in interface ConversationProtocol

Returns:

set of valid initial performatives

getValidResponses

public Set<FIPAPerformative> getValidResponses(FIPAPerformative initiator)

Description copied from interface: ConversationProtocol

Gets valid response performatives for a given initiator.

Specified by:

getValidResponses in interface ConversationProtocol

Parameters:

initiator - the initiating performative

Returns:

set of valid response performatives

getState

public ConversationProtocol.ProtocolState getState()

Description copied from interface: ConversationProtocol

Gets the current protocol state.

Specified by:

getState in interface ConversationProtocol

Returns:

current state

getMessageHistory

public List<FIPAMessage> getMessageHistory()

Description copied from interface: ConversationProtocol

Gets message history for this conversation.

Specified by:

getMessageHistory in interface ConversationProtocol

Returns:

ordered list of messages

createInitialMessage

public FIPAMessage createInitialMessage(String sender,
 String receiver,
 String content)

Description copied from interface: ConversationProtocol

Creates the initial message for this protocol.

Specified by:

createInitialMessage in interface ConversationProtocol

Parameters:

sender - sender agent ID

receiver - receiver agent ID

content - message content

Returns:

initial message

createResponse

public FIPAMessage createResponse(FIPAMessage original,
 FIPAPerformative performative,
 String content)

Description copied from interface: ConversationProtocol

Creates a response to a message.

Specified by:

createResponse in interface ConversationProtocol

Parameters:

original - original message to respond to

performative - response performative

content - response content

Returns:

response message

createAccept

public FIPAMessage createAccept(FIPAMessage proposal,
 String reason)

Creates an accept response.

Parameters:

proposal - original proposal

reason - acceptance reason

Returns:

accept message

createReject

public FIPAMessage createReject(FIPAMessage proposal,
 String reason)

Creates a reject response.

Parameters:

proposal - original proposal

reason - rejection reason

Returns:

reject message

isValidMessage

public boolean isValidMessage(FIPAMessage message)

Description copied from interface: ConversationProtocol

Validates if a message is valid for this protocol.

Specified by:

isValidMessage in interface ConversationProtocol

Parameters:

message - message to validate

Returns:

true if valid

isValidResponse

public boolean isValidResponse(FIPAMessage request,
 FIPAMessage response)

Description copied from interface: ConversationProtocol

Validates if a response is valid for a given request.

Specified by:

isValidResponse in interface ConversationProtocol

Parameters:

request - original request

response - response to validate

Returns:

true if valid response

getValidationErrors

public List<String> getValidationErrors(FIPAMessage message)

Description copied from interface: ConversationProtocol

Gets validation errors for a message.

Specified by:

getValidationErrors in interface ConversationProtocol

Parameters:

message - message to check

Returns:

list of validation errors (empty if valid)

processMessage

public void processMessage(FIPAMessage message)

Description copied from interface: ConversationProtocol

Processes an incoming message and updates state.

Specified by:

processMessage in interface ConversationProtocol

Parameters:

message - message to process

isComplete

public boolean isComplete()

Description copied from interface: ConversationProtocol

Checks if protocol is complete.

Specified by:

isComplete in interface ConversationProtocol

Returns:

true if conversation is finished

isSuccessful

public boolean isSuccessful()

Description copied from interface: ConversationProtocol

Checks if protocol succeeded.

Specified by:

isSuccessful in interface ConversationProtocol

Returns:

true if completed successfully

getResult

public Optional<String> getResult()

Description copied from interface: ConversationProtocol

Gets the final result if available.

Specified by:

getResult in interface ConversationProtocol

Returns:

optional result

reset

public void reset()

Description copied from interface: ConversationProtocol

Resets the protocol for reuse.

Specified by:

reset in interface ConversationProtocol