WonMessage (Core 0.8 API)

java.lang.Object
- won.protocol.message.WonMessage

All Implemented Interfaces:

java.io.Serializable
```
public class WonMessage
extends java.lang.Object
implements java.io.Serializable
```
Wraps an RDF dataset representing a WoN message.
Note: this implementation is not thread-safe.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WonMessage.AttachmentHolder`
`class`	`WonMessage.AttachmentMetaData`
`static class`	`WonMessage.EnvelopePropertyCheckResult`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String ENVELOPE_URI_SUFFIX

static java.lang.String SIGNATURE_URI_SUFFIX

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ENVELOPE_URI_SUFFIX`
`static java.lang.String`	`SIGNATURE_URI_SUFFIX`

Constructor Summary

Constructors
Constructor and Description

WonMessage(org.apache.jena.query.Dataset completeDataset)

Constructors
Constructor and Description
`WonMessage(org.apache.jena.query.Dataset completeDataset)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMessagePropertiesRDFNode(org.apache.jena.rdf.model.Property property, java.util.Collection<org.apache.jena.rdf.model.RDFNode> values)`
`void`	`addMessagePropertiesString(org.apache.jena.rdf.model.Property property, java.util.Collection<java.lang.String> uris)`
`void`	`addMessagePropertiesURI(org.apache.jena.rdf.model.Property property, java.util.Collection<java.net.URI> values)`
`void`	`addMessageProperty(org.apache.jena.rdf.model.Property property, boolean value)` Adds a property to the message resource in the outermost envelope.
`void`	`addMessageProperty(org.apache.jena.rdf.model.Property property, double value)` Adds a property to the message resource in the outermost envelope.
`void`	`addMessageProperty(org.apache.jena.rdf.model.Property property, float value)` Adds a property to the message resource in the outermost envelope.
`void`	`addMessageProperty(org.apache.jena.rdf.model.Property property, int value)` Adds a property to the message resource in the outermost envelope.
`void`	`addMessageProperty(org.apache.jena.rdf.model.Property property, long value)` Adds a property to the message resource in the outermost envelope.
`void`	`addMessageProperty(org.apache.jena.rdf.model.Property property, org.apache.jena.rdf.model.RDFNode value)` Adds a property to the message resource in the head message.
`void`	`addMessageProperty(org.apache.jena.rdf.model.Property property, java.lang.String uri)` Adds a property to the message resource in the outermost envelope.
`void`	`addMessageProperty(org.apache.jena.rdf.model.Property property, java.net.URI value)` Adds a property to the message resource in the outermost envelope.
`WonMessage.EnvelopePropertyCheckResult`	`checkEnvelopeProperties()`
`static WonMessage`	`deepCopy(WonMessage original)`
`boolean`	`equals(java.lang.Object obj)`
`java.util.Set<WonMessage>`	`getAllMessages()` Returns all messages that are present in the dataset that was used to create this WonMessage object.
`java.net.URI`	`getAtomURI()`
`java.net.URI`	`getAtomURIRequired()`
`java.util.List<WonMessage.AttachmentHolder>`	`getAttachments()` Returns all content graphs that are attachments, including their signature graphs.
`org.apache.jena.query.Dataset`	`getCompleteDataset()` Returns the complete dataset, even if this is a multi-message object.
`java.net.URI`	`getConnectionURI()`
`java.net.URI`	`getConnectionURIRequired()`
`java.util.List<java.lang.String>`	`getContentGraphURIs()`
`java.util.Optional<WonMessage>`	`getDeliveryChain()`
`java.net.URI`	`getEnvelopePropertyURIValue(org.apache.jena.rdf.model.Property property)`
`java.net.URI`	`getEnvelopePropertyURIValue(java.net.URI propertyURI)`
`<T> T`	`getEnvelopePropertyValue(org.apache.jena.rdf.model.Property property, java.util.function.Function<org.apache.jena.rdf.model.RDFNode,T> mapper)`
`WonMessageDirection`	`getEnvelopeType()`
`WonMessageDirection`	`getEnvelopeTypeRequired()`
`java.net.URI`	`getEnvelopeURI()`
`WonMessage`	`getFocalMessage()` Return the message 'in focus'.
`java.util.Set<WonMessage>`	`getForwardedMessages()` Returns all messages forwarded by this message and contained in the complete dataset.
`java.util.List<java.net.URI>`	`getForwardedMessageURIRequired()`
`java.util.List<java.net.URI>`	`getForwardedMessageURIs()`
`WonMessage`	`getHeadAndForwarded(boolean recursive)`
`java.util.Optional<WonMessage>`	`getHeadMessage()`
`java.lang.Double`	`getHintScore()`
`java.lang.Double`	`getHintScoreRequired()`
`java.net.URI`	`getHintTargetAtomURI()`
`java.net.URI`	`getHintTargetAtomURIRequired()`
`java.net.URI`	`getHintTargetSocketURI()`
`java.net.URI`	`getHintTargetSocketURIRequired()`
`java.util.List<java.net.URI>`	`getInjectIntoConnectionURIs()`
`java.util.List<java.net.URI>`	`getInjectIntoConnectionURIsRequired()`
`org.apache.jena.query.Dataset`	`getMessageContent()` Creates a new dataset containing only the content graph(s) of the message and their signature (if present).
`WonMessageType`	`getMessageType()`
`WonMessageType`	`getMessageTypeRequired()`
`java.net.URI`	`getMessageURI()`
`java.net.URI`	`getMessageURIRequired()`
`java.util.List<java.net.URI>`	`getPreviousMessageURIs()`
`java.util.List<java.net.URI>`	`getPreviousMessageURIsRequired()`
`java.net.URI`	`getRecipientAtomURI()`
`java.net.URI`	`getRecipientAtomURIRequired()`
`java.net.URI`	`getRecipientNodeURI()`
`java.net.URI`	`getRecipientNodeURIRequired()`
`java.net.URI`	`getRecipientSocketURI()`
`java.net.URI`	`getRecipientSocketURIRequired()`
`java.util.Optional<WonMessage>`	`getRemoteResponse()` Returns the remote response to this message, if it is contained in the complete dataset.
`WonMessageType`	`getRespondingToMessageType()`
`WonMessageType`	`getRespondingToMessageTypeRequired()`
`java.net.URI`	`getRespondingToMessageURI()`
`java.net.URI`	`getRespondingToMessageURIRequired()`
`java.util.Optional<WonMessage>`	`getResponse()` Returns the response to this message, if it is contained in the complete dataset.
`java.net.URI`	`getSenderAtomURI()`
`java.net.URI`	`getSenderAtomURIRequired()`
`java.net.URI`	`getSenderNodeURI()`
`java.net.URI`	`getSenderNodeURIRequired()`
`java.net.URI`	`getSenderSocketURI()`
`java.net.URI`	`getSenderSocketURIRequired()`
`java.net.URI`	`getSignatureURI()`
`java.util.Optional<java.net.URI>`	`getSignerURI()`
`java.net.URI`	`getSignerURIRequired()`
`int`	`hashCode()`
`boolean`	`isEnvelopeGraph(java.lang.String modelUri, org.apache.jena.rdf.model.Model model)`
`boolean`	`isMessageWithBothResponses()`
`boolean`	`isMessageWithResponse()`
`boolean`	`isPartOfDeliveryChain()`
`boolean`	`isRemoteResponse()`
`static WonMessage`	`of(java.util.Collection<WonMessage> messages)`
`static WonMessage`	`of(org.apache.jena.query.Dataset dataset)` Create a WonMessage object from a dataset that may contain multiple messages.
`static WonMessage`	`of(WonMessage... messages)`
`java.lang.String`	`toShortStringForDebug()`
`java.lang.String`	`toStringForDebug(boolean multiline)` Generate a String representaiton of the message for use in log statements.

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

Field Detail

SIGNATURE_URI_SUFFIX

public static final java.lang.String SIGNATURE_URI_SUFFIX

See Also:: Constant Field Values

ENVELOPE_URI_SUFFIX

public static final java.lang.String ENVELOPE_URI_SUFFIX

See Also:: Constant Field Values

Constructor Detail

WonMessage

public WonMessage(org.apache.jena.query.Dataset completeDataset)

Method Detail

of
```
public static WonMessage of(org.apache.jena.query.Dataset dataset)
```
Create a WonMessage object from a dataset that may contain multiple messages.

Parameters:

dataset -

Returns:

of

public static WonMessage of(java.util.Collection<WonMessage> messages)

of

public static WonMessage of(WonMessage... messages)

deepCopy

public static WonMessage deepCopy(WonMessage original)

getCompleteDataset
```
public org.apache.jena.query.Dataset getCompleteDataset()
```
Returns the complete dataset, even if this is a multi-message object.

Returns:

getFocalMessage
```
public WonMessage getFocalMessage()
```
Return the message 'in focus'. Which one that is depends on the state of the delivery chain in the dataset that this WonMessage object was created from. Options are:
- New message is being sent (=headMessage): no responses yet, the headMessage is in focus.
- The sender's node has produced a response: the response is now 'in focus'. The combined (head + response) are returned to the sender and forwarded to the recipient.
- The reipient's node has produced a response: two options:
  - The sender receives a message containing just the recipient node's response (=remoteResponse). In that Message, this response is in focus.
  - The recipient gets a dataset containing the headMessage plus both responses. The headMessage is in focus here.
Returns:

getAllMessages
```
public java.util.Set<WonMessage> getAllMessages()
```
Returns all messages that are present in the dataset that was used to create this WonMessage object.

Returns:

getForwardedMessages
```
public java.util.Set<WonMessage> getForwardedMessages()
```
Returns all messages forwarded by this message and contained in the complete dataset.

Returns:

getHeadAndForwarded

public WonMessage getHeadAndForwarded(boolean recursive)

getHeadMessage

public java.util.Optional<WonMessage> getHeadMessage()

getResponse
```
public java.util.Optional<WonMessage> getResponse()
```
Returns the response to this message, if it is contained in the complete dataset.

Returns:

getRemoteResponse
```
public java.util.Optional<WonMessage> getRemoteResponse()
```
Returns the remote response to this message, if it is contained in the complete dataset.

Returns:

isPartOfDeliveryChain

public boolean isPartOfDeliveryChain()

getDeliveryChain

public java.util.Optional<WonMessage> getDeliveryChain()

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

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

getSignerURIRequired

public java.net.URI getSignerURIRequired()

getSignerURI

public java.util.Optional<java.net.URI> getSignerURI()

addMessageProperty

public void addMessageProperty(org.apache.jena.rdf.model.Property property,
                               org.apache.jena.rdf.model.RDFNode value)

Adds a property to the message resource in the head message.

Parameters:: property -; value -

addMessagePropertiesRDFNode

public void addMessagePropertiesRDFNode(org.apache.jena.rdf.model.Property property,
                                        java.util.Collection<org.apache.jena.rdf.model.RDFNode> values)

addMessageProperty
```
public void addMessageProperty(org.apache.jena.rdf.model.Property property,
                               java.lang.String uri)
```
Adds a property to the message resource in the outermost envelope.

Parameters:

property -

uri - the object of the property, assumed to be an uri