ConversationMessage (Utilities Conversation 0.9 API)

java.lang.Object
- won.protocol.agreement.ConversationMessage

All Implemented Interfaces:: java.lang.Comparable<ConversationMessage>

public class ConversationMessage
extends java.lang.Object
implements java.lang.Comparable<ConversationMessage>

Author:: fkleedorfer

Constructor Summary

Constructors
Constructor and Description

ConversationMessage(java.net.URI messageURI)

Constructors
Constructor and Description
`ConversationMessage(java.net.URI messageURI)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accepts(ConversationMessage other)`
`void`	`addAccepts(java.net.URI accepts)`
`void`	`addAcceptsInverseRef(ConversationMessage ref)`
`void`	`addAcceptsRef(ConversationMessage ref)`
`void`	`addClaims(java.net.URI claims)`
`void`	`addClaimsInverseRef(ConversationMessage ref)`
`void`	`addClaimsRef(ConversationMessage ref)`
`void`	`addContentGraph(java.net.URI contentGraph)`
`void`	`addForwarded(java.net.URI forwarded)`
`void`	`addForwardedInverseRef(ConversationMessage ref)`
`void`	`addForwardedRef(ConversationMessage ref)`
`void`	`addPrevious(java.net.URI previous)`
`void`	`addPreviousInverseRef(ConversationMessage ref)`
`void`	`addPreviousRef(ConversationMessage ref)`
`void`	`addProposes(java.net.URI proposes)`
`void`	`addProposesInverseRef(ConversationMessage ref)`
`void`	`addProposesRef(ConversationMessage ref)`
`void`	`addProposesToCancel(java.net.URI proposesToCancel)`
`void`	`addProposesToCancelInverseRef(ConversationMessage ref)`
`void`	`addProposesToCancelRef(ConversationMessage ref)`
`void`	`addRejects(java.net.URI rejects)`
`void`	`addRejectsInverseRef(ConversationMessage ref)`
`void`	`addRejectsRef(ConversationMessage ref)`
`void`	`addRetracts(java.net.URI retracts)`
`void`	`addRetractsInverseRef(ConversationMessage ref)`
`void`	`addRetractsRef(ConversationMessage ref)`
`boolean`	`claims(ConversationMessage other)`
`int`	`compareTo(ConversationMessage other)` Compares messages for sorting them temporally, using the URI as tie breaker so as to ensure a stable ordering.
`boolean`	`equals(java.lang.Object obj)`
`java.util.Set<java.net.URI>`	`getAccepts()`
`java.util.Set<ConversationMessage>`	`getAcceptsInverseRefs()`
`java.util.Set<ConversationMessage>`	`getAcceptsRefs()`
`java.util.Set<java.net.URI>`	`getClaims()`
`java.util.Set<ConversationMessage>`	`getClaimsInverseRefs()`
`java.util.Set<ConversationMessage>`	`getClaimsRefs()`
`java.util.Set<java.net.URI>`	`getContentGraphs()`
`DeliveryChain`	`getDeliveryChain()`
`WonMessageDirection`	`getDirection()`
`java.util.Set<MessageEffect>`	`getEffects()`
`java.util.Set<java.net.URI>`	`getForwarded()`
`java.util.Set<ConversationMessage>`	`getForwardedInverseRefs()`
`java.util.Set<ConversationMessage>`	`getForwardedRefs()`
`WonMessageType`	`getMessageType()`
`java.net.URI`	`getMessageURI()`
`int`	`getOrder()`
`org.apache.thrift.Option<ConversationMessage>`	`getOwnConversationRoot()`
`java.util.Set<java.net.URI>`	`getPrevious()`
`java.util.Set<ConversationMessage>`	`getPreviousInverseRefs()`
`java.util.Set<ConversationMessage>`	`getPreviousRefs()`
`java.util.Set<java.net.URI>`	`getProposes()`
`java.util.Set<ConversationMessage>`	`getProposesInverseRefs()`
`java.util.Set<ConversationMessage>`	`getProposesRefs()`
`java.util.Set<java.net.URI>`	`getProposesToCancel()`
`java.util.Set<ConversationMessage>`	`getProposesToCancelInverseRefs()`
`java.util.Set<ConversationMessage>`	`getProposesToCancelRefs()`
`java.util.Set<ConversationMessage>`	`getReachableConversationRoots()`
`java.util.Set<java.net.URI>`	`getRejects()`
`java.util.Set<ConversationMessage>`	`getRejectsInverseRefs()`
`java.util.Set<ConversationMessage>`	`getRejectsRefs()`
`java.net.URI`	`getRemotelyRespondingTo()`
`ConversationMessage`	`getRemotelyRespondingToInverseRef()`
`ConversationMessage`	`getRemotelyRespondingToRef()`
`java.net.URI`	`getRespondingTo()`
`ConversationMessage`	`getRespondingToInverseRef()`
`java.util.Optional<ConversationMessage>`	`getRespondingToOption()` Return an optional conversation message here - it's possible that we only have the response, not the original one.
`java.util.Set<java.net.URI>`	`getRetracts()`
`java.util.Set<ConversationMessage>`	`getRetractsInverseRefs()`
`java.util.Set<ConversationMessage>`	`getRetractsRefs()`
`ConversationMessage`	`getRootOfDeliveryChain()`
`java.net.URI`	`getSenderAtomURI()`
`int`	`hashCode()`
`boolean`	`hasRemoteResponse()`
`boolean`	`hasRemoteResponse(ConversationMessage other)`
`boolean`	`hasRemoteSuccessResponse()`
`boolean`	`hasResponse()`
`boolean`	`hasResponse(ConversationMessage other)`
`boolean`	`hasSubsequentMessage()`
`boolean`	`hasSuccessResponse()`
`boolean`	`isAcceptsMessage()`
`boolean`	`isAcknowledgedLocally()`
`boolean`	`isAcknowledgedRemotely()`
`boolean`	`isAfter(ConversationMessage other)`
`boolean`	`isAgreementProtocolMessage()`
`boolean`	`isClaimsMessage()`
`boolean`	`isEndOfDeliveryChain()`
`boolean`	`isForwardedMessage()`
`boolean`	`isFromExternal()`
`boolean`	`isFromOwner()`
`boolean`	`isFromSystem()`
`boolean`	`isHeadOfDeliveryChain()`
`boolean`	`isInSameDeliveryChain(ConversationMessage other)`
`boolean`	`isProposesMessage()`
`boolean`	`isProposesToCancelMessage()`
`boolean`	`isRejectsMessage()`
`boolean`	`isResponse()`
`boolean`	`isRetractsMessage()`
`boolean`	`partOfSameExchange(ConversationMessage other)`
`boolean`	`previousMessage()`
`boolean`	`proposes(ConversationMessage other)`
`boolean`	`proposesToCancel(ConversationMessage other)`
`boolean`	`rejects(ConversationMessage other)`
`boolean`	`remotelyRespondingTo(ConversationMessage other)`
`void`	`removeHighlevelProtocolProperties()` Removes all proposes, claims, rejects, accepts, proposesToCancel, contentGraphs
`boolean`	`respondingTo(ConversationMessage other)`
`boolean`	`retracts(ConversationMessage other)`
`void`	`setDirection(WonMessageDirection direction)`
`void`	`setEffects(java.util.Set<MessageEffect> effects)`
`void`	`setMessageType(WonMessageType messageType)`
`void`	`setRemotelyRespondingTo(java.net.URI remotelyRespondingTo)`
`void`	`setRemotelyRespondingToInverseRef(ConversationMessage ref)`
`void`	`setRemotelyRespondingToRef(ConversationMessage ref)`
`void`	`setRespondingTo(java.net.URI respondingTo)`
`void`	`setRespondingToInverseRef(ConversationMessage ref)`
`void`	`setRespondingToRef(ConversationMessage ref)`
`void`	`setSenderAtomURI(java.net.URI senderAtomURI)`
`boolean`	`sharesReachableRootsWith(ConversationMessage other)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConversationMessage

public ConversationMessage(java.net.URI messageURI)

Method Detail

removeHighlevelProtocolProperties
```
public void removeHighlevelProtocolProperties()
```
Removes all proposes, claims, rejects, accepts, proposesToCancel, contentGraphs

isForwardedMessage
```
public boolean isForwardedMessage()
```

getRootOfDeliveryChain

public ConversationMessage getRootOfDeliveryChain()

isHeadOfDeliveryChain

public boolean isHeadOfDeliveryChain()

isEndOfDeliveryChain
```
public boolean isEndOfDeliveryChain()
```

isInSameDeliveryChain

public boolean isInSameDeliveryChain(ConversationMessage other)

getDeliveryChain

public DeliveryChain getDeliveryChain()

isResponse
```
public boolean isResponse()
```

hasResponse
```
public boolean hasResponse()
```

hasRemoteResponse
```
public boolean hasRemoteResponse()
```

hasSuccessResponse
```
public boolean hasSuccessResponse()
```

hasRemoteSuccessResponse

public boolean hasRemoteSuccessResponse()

isAcknowledgedRemotely

public boolean isAcknowledgedRemotely()

previousMessage
```
public boolean previousMessage()
```

hasSubsequentMessage
```
public boolean hasSubsequentMessage()
```

respondingTo

public boolean respondingTo(ConversationMessage other)

hasResponse

public boolean hasResponse(ConversationMessage other)

remotelyRespondingTo

public boolean remotelyRespondingTo(ConversationMessage other)

hasRemoteResponse

public boolean hasRemoteResponse(ConversationMessage other)

partOfSameExchange

public boolean partOfSameExchange(ConversationMessage other)

compareTo
```
public int compareTo(ConversationMessage other)
```
Compares messages for sorting them temporally, using the URI as tie breaker so as to ensure a stable ordering.

Specified by:

compareTo in interface java.lang.Comparable<ConversationMessage>

Parameters:

other -

Returns:

getOrder
```
public int getOrder()
```

getOwnConversationRoot

public org.apache.thrift.Option<ConversationMessage> getOwnConversationRoot()

getReachableConversationRoots

public java.util.Set<ConversationMessage> getReachableConversationRoots()

sharesReachableRootsWith

public boolean sharesReachableRootsWith(ConversationMessage other)

isAfter

public boolean isAfter(ConversationMessage other)

isAgreementProtocolMessage

public boolean isAgreementProtocolMessage()

isFromOwner
```
public boolean isFromOwner()
```

isFromExternal
```
public boolean isFromExternal()
```

isFromSystem
```
public boolean isFromSystem()
```

isAcknowledgedLocally

public boolean isAcknowledgedLocally()

isRetractsMessage
```
public boolean isRetractsMessage()
```

isAcceptsMessage
```
public boolean isAcceptsMessage()
```

isProposesMessage
```
public boolean isProposesMessage()
```

isClaimsMessage
```
public boolean isClaimsMessage()
```

isRejectsMessage
```
public boolean isRejectsMessage()
```

isProposesToCancelMessage

public boolean isProposesToCancelMessage()

proposes

public boolean proposes(ConversationMessage other)

claims

public boolean claims(ConversationMessage other)

accepts

public boolean accepts(ConversationMessage other)

proposesToCancel

public boolean proposesToCancel(ConversationMessage other)

retracts

public boolean retracts(ConversationMessage other)

rejects

public boolean rejects(ConversationMessage other)

getMessageURI
```
public java.net.URI getMessageURI()
```

getSenderAtomURI

public java.net.URI getSenderAtomURI()

setSenderAtomURI

public void setSenderAtomURI(java.net.URI senderAtomURI)

getProposes

public java.util.Set<java.net.URI> getProposes()

getClaims

public java.util.Set<java.net.URI> getClaims()

getRejects

public java.util.Set<java.net.URI> getRejects()

getProposesRefs

public java.util.Set<ConversationMessage> getProposesRefs()

addProposes

public void addProposes(java.net.URI proposes)

addProposesRef

public void addProposesRef(ConversationMessage ref)

getClaimsRefs

public java.util.Set<ConversationMessage> getClaimsRefs()

addClaims

public void addClaims(java.net.URI claims)

addClaimsRef

public void addClaimsRef(ConversationMessage ref)

getRejectsRefs

public java.util.Set<ConversationMessage> getRejectsRefs()

addRejects

public void addRejects(java.net.URI rejects)

addRejectsRef

public void addRejectsRef(ConversationMessage ref)

getPrevious

public java.util.Set<java.net.URI> getPrevious()

getPreviousRefs

public java.util.Set<ConversationMessage> getPreviousRefs()

addPrevious

public void addPrevious(java.net.URI previous)

addPreviousRef

public void addPreviousRef(ConversationMessage ref)

getForwarded

public java.util.Set<java.net.URI> getForwarded()

getForwardedRefs

public java.util.Set<ConversationMessage> getForwardedRefs()

addForwarded

public void addForwarded(java.net.URI forwarded)

addForwardedRef

public void addForwardedRef(ConversationMessage ref)

getAccepts

public java.util.Set<java.net.URI> getAccepts()

getAcceptsRefs

public java.util.Set<ConversationMessage> getAcceptsRefs()

addAcceptsRef

public void addAcceptsRef(ConversationMessage ref)

addAccepts

public void addAccepts(java.net.URI accepts)

getRetracts

public java.util.Set<java.net.URI> getRetracts()

getRetractsRefs

public java.util.Set<ConversationMessage> getRetractsRefs()

addRetractsRef

public void addRetractsRef(ConversationMessage ref)

addRetracts

public void addRetracts(java.net.URI retracts)

getProposesToCancel

public java.util.Set<java.net.URI> getProposesToCancel()

getProposesToCancelRefs

public java.util.Set<ConversationMessage> getProposesToCancelRefs()

addProposesToCancelRef

public void addProposesToCancelRef(ConversationMessage ref)

addProposesToCancel

public void addProposesToCancel(java.net.URI proposesToCancel)

getRespondingTo
```
public java.net.URI getRespondingTo()
```

setRespondingTo

public void setRespondingTo(java.net.URI respondingTo)

getRespondingToOption
```
public java.util.Optional<ConversationMessage> getRespondingToOption()
```
Return an optional conversation message here - it's possible that we only have the response, not the original one.

Returns:

setRespondingToRef

public void setRespondingToRef(ConversationMessage ref)

getRemotelyRespondingTo

public java.net.URI getRemotelyRespondingTo()

setRemotelyRespondingTo

public void setRemotelyRespondingTo(java.net.URI remotelyRespondingTo)

getRemotelyRespondingToRef

public ConversationMessage getRemotelyRespondingToRef()

setRemotelyRespondingToRef

public void setRemotelyRespondingToRef(ConversationMessage ref)

getProposesInverseRefs

public java.util.Set<ConversationMessage> getProposesInverseRefs()

addProposesInverseRef

public void addProposesInverseRef(ConversationMessage ref)

getClaimsInverseRefs

public java.util.Set<ConversationMessage> getClaimsInverseRefs()

addClaimsInverseRef

public void addClaimsInverseRef(ConversationMessage ref)

getRejectsInverseRefs

public java.util.Set<ConversationMessage> getRejectsInverseRefs()

addRejectsInverseRef

public void addRejectsInverseRef(ConversationMessage ref)

getPreviousInverseRefs

public java.util.Set<ConversationMessage> getPreviousInverseRefs()

addPreviousInverseRef

public void addPreviousInverseRef(ConversationMessage ref)

getForwardedInverseRefs

public java.util.Set<ConversationMessage> getForwardedInverseRefs()

addForwardedInverseRef

public void addForwardedInverseRef(ConversationMessage ref)

getAcceptsInverseRefs

public java.util.Set<ConversationMessage> getAcceptsInverseRefs()

addAcceptsInverseRef

public void addAcceptsInverseRef(ConversationMessage ref)

getRetractsInverseRefs

public java.util.Set<ConversationMessage> getRetractsInverseRefs()

addRetractsInverseRef

public void addRetractsInverseRef(ConversationMessage ref)

getRespondingToInverseRef

public ConversationMessage getRespondingToInverseRef()

setRespondingToInverseRef

public void setRespondingToInverseRef(ConversationMessage ref)

getRemotelyRespondingToInverseRef

public ConversationMessage getRemotelyRespondingToInverseRef()

setRemotelyRespondingToInverseRef

public void setRemotelyRespondingToInverseRef(ConversationMessage ref)

getProposesToCancelInverseRefs

public java.util.Set<ConversationMessage> getProposesToCancelInverseRefs()

addProposesToCancelInverseRef

public void addProposesToCancelInverseRef(ConversationMessage ref)

getContentGraphs

public java.util.Set<java.net.URI> getContentGraphs()

addContentGraph

public void addContentGraph(java.net.URI contentGraph)

getMessageType

public WonMessageType getMessageType()

setMessageType

public void setMessageType(WonMessageType messageType)

getDirection

public WonMessageDirection getDirection()

setDirection

public void setDirection(WonMessageDirection direction)

setEffects

public void setEffects(java.util.Set<MessageEffect> effects)

getEffects

public java.util.Set<MessageEffect> getEffects()

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:: equals in class java.lang.Object

Class ConversationMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConversationMessage

Method Detail

removeHighlevelProtocolProperties

isForwardedMessage

getRootOfDeliveryChain

isHeadOfDeliveryChain

isEndOfDeliveryChain

isInSameDeliveryChain

getDeliveryChain

isResponse

hasResponse

hasRemoteResponse

hasSuccessResponse

hasRemoteSuccessResponse

isAcknowledgedRemotely

previousMessage

hasSubsequentMessage

respondingTo

hasResponse

remotelyRespondingTo

hasRemoteResponse

partOfSameExchange

compareTo

getOrder

getOwnConversationRoot

getReachableConversationRoots

sharesReachableRootsWith

isAfter

isAgreementProtocolMessage

isFromOwner

isFromExternal

isFromSystem

isAcknowledgedLocally

isRetractsMessage

isAcceptsMessage

isProposesMessage

isClaimsMessage

isRejectsMessage

isProposesToCancelMessage

proposes

claims

accepts

proposesToCancel

retracts

rejects

getMessageURI

getSenderAtomURI

setSenderAtomURI

getProposes

getClaims

getRejects

getProposesRefs

addProposes

addProposesRef

getClaimsRefs

addClaims

addClaimsRef

getRejectsRefs

addRejects

addRejectsRef

getPrevious

getPreviousRefs

addPrevious

addPreviousRef

getForwarded

getForwardedRefs

addForwarded

addForwardedRef

getAccepts

getAcceptsRefs

addAcceptsRef

addAccepts

getRetracts

getRetractsRefs

addRetractsRef