won.protocol.message

Class WonMessageBuilder

java.lang.Object

won.protocol.message.WonMessageBuilder

public class WonMessageBuilder
extends java.lang.Object

Class to build a WonMessage based on the specific properties.

Author:

Fabian Salcher

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
WonMessageBuilder(java.net.URI messageURI)

Method Summary

Modifier and Type	Method and Description
void	addAsContainedEnvelope(org.apache.jena.query.Dataset dataset, org.apache.jena.rdf.model.Model envelopeGraph, org.apache.jena.rdf.model.Resource envelopeGraphResource, WonMessage messageToAdd, java.net.URI messageURI)
WonMessageBuilder	addContent(org.apache.jena.query.Dataset dataset) Adds all graphs in the specified dataset as content graphs to the message.
WonMessageBuilder	addContent(org.apache.jena.rdf.model.Model content) Adds the specified content graph, and the specified signature graph, using the specified contentURI as the graph name.
WonMessageBuilder	addRefersToURI(java.net.URI refersTo)
void	addWrappedOrForwardedMessage(org.apache.jena.query.Dataset dataset, org.apache.jena.rdf.model.Model envelopeGraph, org.apache.jena.rdf.model.Resource envelopeGraphResource, java.net.URI messageURI)
WonMessage	build()
WonMessage	build(org.apache.jena.query.Dataset dataset) Builds a WonMessage by adding data to the specified dataset.
static WonMessageBuilder	copyEnvelopeFromWonMessage(WonMessage wonMessage) Copies the envelope properties from the specified message to this message.
static WonMessage	forwardReceivedNodeToNodeMessageAsNodeToNodeMessage(java.net.URI newMessageUri, WonMessage wonMessage, java.net.URI connectionURI, java.net.URI needURI, java.net.URI wonNodeUri, java.net.URI remoteConnectionURI, java.net.URI remoteNeedURI, java.net.URI remoteWonNodeUri)
org.apache.jena.rdf.model.Model	getUnsignedContentGraph() Retrieves one of the possibly multiple Models that does not have a signature yet.
WonMessageBuilder	setCorrespondingRemoteMessageURI(java.net.URI correspondingRemoteMessageURI)
WonMessageBuilder	setForwardedMessageURI(java.net.URI forwardedMessageURI)
WonMessageBuilder	setIsRemoteResponseToMessageURI(java.net.URI isRemoteResponseToMessageURI)
WonMessageBuilder	setIsResponseToMessageType(WonMessageType isResponseToMessageType)
WonMessageBuilder	setIsResponseToMessageURI(java.net.URI isResponseToMessageURI)
static WonMessageBuilder	setMessagePropertiesForClose(java.net.URI messageURI, java.net.URI localConnection, java.net.URI localNeed, java.net.URI localWonNode, java.lang.String farewellMessage)
static WonMessageBuilder	setMessagePropertiesForClose(java.net.URI messageURI, java.net.URI localConnection, java.net.URI localNeed, java.net.URI localWonNode, java.net.URI remoteConnection, java.net.URI remoteNeed, java.net.URI remoteWonNode, java.lang.String farewellMessage)
static WonMessageBuilder	setMessagePropertiesForClose(java.net.URI messageURI, WonMessageDirection direction, java.net.URI localConnection, java.net.URI localNeed, java.net.URI localWonNode, java.lang.String farewellMessage)
static WonMessageBuilder	setMessagePropertiesForClose(java.net.URI messageURI, WonMessageDirection direction, java.net.URI localConnection, java.net.URI localNeed, java.net.URI localWonNode, java.net.URI remoteConnection, java.net.URI remoteNeed, java.net.URI remoteWonNode, java.lang.String farewellMessage)
static WonMessageBuilder	setMessagePropertiesForConnect(java.net.URI messageURI, java.net.URI localFacet, java.net.URI localNeed, java.net.URI localWonNode, java.net.URI remoteFacet, java.net.URI remoteNeed, java.net.URI remoteWonNode, java.lang.String welcomeMessage)
static WonMessageBuilder	setMessagePropertiesForConnectionMessage(java.net.URI messageURI, java.net.URI localConnection, java.net.URI localNeed, java.net.URI localWonNode, java.net.URI remoteConnection, java.net.URI remoteNeed, java.net.URI remoteWonNode, org.apache.jena.rdf.model.Model content)
static WonMessageBuilder	setMessagePropertiesForConnectionMessage(java.net.URI messageURI, java.net.URI localConnection, java.net.URI localNeed, java.net.URI localWonNode, java.net.URI remoteConnection, java.net.URI remoteNeed, java.net.URI remoteWonNode, java.lang.String textMessage)
static WonMessageBuilder	setMessagePropertiesForCreate(java.net.URI messageURI, java.net.URI needURI, java.net.URI wonNodeURI)
static WonMessageBuilder	setMessagePropertiesForDeactivateFromOwner(java.net.URI messageURI, java.net.URI localNeed, java.net.URI localWonNode)
static WonMessageBuilder	setMessagePropertiesForDeactivateFromSystem(java.net.URI messageURI, java.net.URI localNeed, java.net.URI localWonNode)
static WonMessageBuilder	setMessagePropertiesForHint(java.net.URI messageURI, java.net.URI needURI, java.net.URI needFacetURI, java.net.URI wonNodeURI, java.net.URI otherNeedURI, java.net.URI otherNeedFacet, java.net.URI matcherURI, double score)
static WonMessageBuilder	setMessagePropertiesForHintFeedback(java.net.URI messageURI, java.net.URI connectionURI, java.net.URI needURI, java.net.URI wonNodeURI, boolean booleanFeedbackValue)
static WonMessageBuilder	setMessagePropertiesForHintNotification(java.net.URI messageURI, java.net.URI needURI, java.net.URI needFacetURI, java.net.URI needConnectionURI, java.net.URI wonNodeURI, java.net.URI otherNeedURI, java.net.URI otherNeedFacet, java.net.URI matcherURI, double score)
static WonMessageBuilder	setMessagePropertiesForLocalOnlyClose(java.net.URI messageURI, java.net.URI localConnection, java.net.URI localNeed, java.net.URI localWonNode) Sets the MessageProperties for Closing open connections (happens when the need is closed and the system is closing all the corresponding connections when no connection is present from the remoteNeed
static WonMessageBuilder	setMessagePropertiesForNeedCreatedNotification(java.net.URI messageURI, java.net.URI localNeed, java.net.URI localWonNode)
static WonMessageBuilder	setMessagePropertiesForNeedMessageFromSystem(java.net.URI messageURI, java.net.URI localNeed, java.net.URI localWonNode) Sets message properties for sending a 'need message' from System to Owner, i.e.
static WonMessageBuilder	setMessagePropertiesForOpen(java.net.URI messageURI, java.net.URI localConnection, java.net.URI localNeed, java.net.URI localWonNode, java.net.URI remoteConnection, java.net.URI remoteNeed, java.net.URI remoteWonNode, java.lang.String welcomeMessage)
static WonMessageBuilder	setPropertiesForNodeResponse(WonMessage originalMessage, boolean isSuccess, java.net.URI messageURI)
static WonMessageBuilder	setPropertiesForPassingMessageToOwner(WonMessage externalMsg) Deprecated.
static WonMessageBuilder	setPropertiesForPassingMessageToRemoteNode(WonMessage ownerOrSystemMsg, java.net.URI newMessageUri)
WonMessageBuilder	setReceivedTimestamp(java.lang.Long receivedTimestamp)
WonMessageBuilder	setReceivedTimestampToNow()
WonMessageBuilder	setReceiverNeedURI(java.net.URI receiverNeedURI)
WonMessageBuilder	setReceiverNodeURI(java.net.URI receiverNodeURI)
WonMessageBuilder	setReceiverURI(java.net.URI receiverURI)
WonMessageBuilder	setSenderNeedURI(java.net.URI senderNeedURI)
WonMessageBuilder	setSenderNodeURI(java.net.URI senderNodeURI)
WonMessageBuilder	setSenderURI(java.net.URI senderURI)
WonMessageBuilder	setSentTimestamp(long sentTimestamp)
WonMessageBuilder	setSentTimestampToNow()
WonMessageBuilder	setTextMessage(java.lang.String textMessage) Adds a won:hasTextMessage triple to one of the unsigned content graphs in this builder.
WonMessageBuilder	setWonMessageDirection(WonMessageDirection wonMessageDirection)
WonMessageBuilder	setWonMessageType(WonMessageType wonMessageType)
static WonMessageBuilder	wrap(WonMessage toWrap) Adds the complete message content to the message that will be built, referencing toWrap's envelope in the envelope of the new message.

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_URI_SUFFIX

public static final java.lang.String CONTENT_URI_SUFFIX

See Also:

Constant Field Values

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

WonMessageBuilder

public WonMessageBuilder(java.net.URI messageURI)

Method Detail

build

public WonMessage build()
                 throws WonMessageBuilderException

Throws:

WonMessageBuilderException

build

public WonMessage build(org.apache.jena.query.Dataset dataset)
                 throws WonMessageBuilderException

Builds a WonMessage by adding data to the specified dataset. The dataset may be null or empty.

Parameters:

dataset -

Returns:

Throws:

WonMessageBuilderException

addWrappedOrForwardedMessage

public void addWrappedOrForwardedMessage(org.apache.jena.query.Dataset dataset,
                                         org.apache.jena.rdf.model.Model envelopeGraph,
                                         org.apache.jena.rdf.model.Resource envelopeGraphResource,
                                         java.net.URI messageURI)

addAsContainedEnvelope

public void addAsContainedEnvelope(org.apache.jena.query.Dataset dataset,
                                   org.apache.jena.rdf.model.Model envelopeGraph,
                                   org.apache.jena.rdf.model.Resource envelopeGraphResource,
                                   WonMessage messageToAdd,
                                   java.net.URI messageURI)

wrap

public static WonMessageBuilder wrap(WonMessage toWrap)

Adds the complete message content to the message that will be built, referencing toWrap's envelope in the envelope of the new message. The message that will be built has the same messageURI as the wrapped message.

Parameters:

-

Returns:

setMessagePropertiesForOpen

public static WonMessageBuilder setMessagePropertiesForOpen(java.net.URI messageURI,
                                                            java.net.URI localConnection,
                                                            java.net.URI localNeed,
                                                            java.net.URI localWonNode,
                                                            java.net.URI remoteConnection,
                                                            java.net.URI remoteNeed,
                                                            java.net.URI remoteWonNode,
                                                            java.lang.String welcomeMessage)

setMessagePropertiesForClose

public static WonMessageBuilder setMessagePropertiesForClose(java.net.URI messageURI,
                                                             java.net.URI localConnection,
                                                             java.net.URI localNeed,
                                                             java.net.URI localWonNode,
                                                             java.net.URI remoteConnection,
                                                             java.net.URI remoteNeed,
                                                             java.net.URI remoteWonNode,
                                                             java.lang.String farewellMessage)

setMessagePropertiesForClose

public static WonMessageBuilder setMessagePropertiesForClose(java.net.URI messageURI,
                                                             WonMessageDirection direction,
                                                             java.net.URI localConnection,
                                                             java.net.URI localNeed,
                                                             java.net.URI localWonNode,
                                                             java.net.URI remoteConnection,
                                                             java.net.URI remoteNeed,
                                                             java.net.URI remoteWonNode,
                                                             java.lang.String farewellMessage)

setMessagePropertiesForClose

public static WonMessageBuilder setMessagePropertiesForClose(java.net.URI messageURI,
                                                             java.net.URI localConnection,
                                                             java.net.URI localNeed,
                                                             java.net.URI localWonNode,
                                                             java.lang.String farewellMessage)

setMessagePropertiesForClose

public static WonMessageBuilder setMessagePropertiesForClose(java.net.URI messageURI,
                                                             WonMessageDirection direction,
                                                             java.net.URI localConnection,
                                                             java.net.URI localNeed,
                                                             java.net.URI localWonNode,
                                                             java.lang.String farewellMessage)

setMessagePropertiesForLocalOnlyClose

public static WonMessageBuilder setMessagePropertiesForLocalOnlyClose(java.net.URI messageURI,
                                                                      java.net.URI localConnection,
                                                                      java.net.URI localNeed,
                                                                      java.net.URI localWonNode)

Sets the MessageProperties for Closing open connections (happens when the need is closed and the system is closing all the corresponding connections when no connection is present from the remoteNeed

Parameters:

messageURI -

localConnection -

localNeed -

localWonNode -

Returns:

setMessagePropertiesForDeactivateFromOwner

public static WonMessageBuilder setMessagePropertiesForDeactivateFromOwner(java.net.URI messageURI,
                                                                           java.net.URI localNeed,
                                                                           java.net.URI localWonNode)

setMessagePropertiesForDeactivateFromSystem

public static WonMessageBuilder setMessagePropertiesForDeactivateFromSystem(java.net.URI messageURI,
                                                                            java.net.URI localNeed,
                                                                            java.net.URI localWonNode)

setMessagePropertiesForNeedMessageFromSystem

public static WonMessageBuilder setMessagePropertiesForNeedMessageFromSystem(java.net.URI messageURI,
                                                                             java.net.URI localNeed,
                                                                             java.net.URI localWonNode)

Sets message properties for sending a 'need message' from System to Owner, i.e. a notification from the node to the owner. This message will have no effect on need or connection states and it is expected that a payload (e.g. via setTextMessage()) is added to the message builder prior to calling the build() method.

Parameters:

messageURI -

localNeed -

localWonNode -

Returns:

setMessagePropertiesForConnect

public static WonMessageBuilder setMessagePropertiesForConnect(java.net.URI messageURI,
                                                               java.net.URI localFacet,
                                                               java.net.URI localNeed,
                                                               java.net.URI localWonNode,
                                                               java.net.URI remoteFacet,
                                                               java.net.URI remoteNeed,
                                                               java.net.URI remoteWonNode,
                                                               java.lang.String welcomeMessage)

setMessagePropertiesForCreate

public static WonMessageBuilder setMessagePropertiesForCreate(java.net.URI messageURI,
                                                              java.net.URI needURI,
                                                              java.net.URI wonNodeURI)

setMessagePropertiesForHint

public static WonMessageBuilder setMessagePropertiesForHint(java.net.URI messageURI,
                                                            java.net.URI needURI,
                                                            java.net.URI needFacetURI,
                                                            java.net.URI wonNodeURI,
                                                            java.net.URI otherNeedURI,
                                                            java.net.URI otherNeedFacet,
                                                            java.net.URI matcherURI,
                                                            double score)

setMessagePropertiesForHintFeedback

public static WonMessageBuilder setMessagePropertiesForHintFeedback(java.net.URI messageURI,
                                                                    java.net.URI connectionURI,
                                                                    java.net.URI needURI,
                                                                    java.net.URI wonNodeURI,
                                                                    boolean booleanFeedbackValue)

setMessagePropertiesForHintNotification

public static WonMessageBuilder setMessagePropertiesForHintNotification(java.net.URI messageURI,
                                                                        java.net.URI needURI,
                                                                        java.net.URI needFacetURI,
                                                                        java.net.URI needConnectionURI,
                                                                        java.net.URI wonNodeURI,
                                                                        java.net.URI otherNeedURI,
                                                                        java.net.URI otherNeedFacet,
                                                                        java.net.URI matcherURI,
                                                                        double score)

setMessagePropertiesForConnectionMessage

public static WonMessageBuilder setMessagePropertiesForConnectionMessage(java.net.URI messageURI,
                                                                         java.net.URI localConnection,
                                                                         java.net.URI localNeed,
                                                                         java.net.URI localWonNode,
                                                                         java.net.URI remoteConnection,
                                                                         java.net.URI remoteNeed,
                                                                         java.net.URI remoteWonNode,
                                                                         org.apache.jena.rdf.model.Model content)

setMessagePropertiesForConnectionMessage

public static WonMessageBuilder setMessagePropertiesForConnectionMessage(java.net.URI messageURI,
                                                                         java.net.URI localConnection,
                                                                         java.net.URI localNeed,
                                                                         java.net.URI localWonNode,
                                                                         java.net.URI remoteConnection,
                                                                         java.net.URI remoteNeed,
                                                                         java.net.URI remoteWonNode,
                                                                         java.lang.String textMessage)

setMessagePropertiesForNeedCreatedNotification

public static WonMessageBuilder setMessagePropertiesForNeedCreatedNotification(java.net.URI messageURI,
                                                                               java.net.URI localNeed,
                                                                               java.net.URI localWonNode)

setPropertiesForPassingMessageToRemoteNode

public static WonMessageBuilder setPropertiesForPassingMessageToRemoteNode(WonMessage ownerOrSystemMsg,
                                                                           java.net.URI newMessageUri)

setPropertiesForPassingMessageToOwner

@Deprecated
public static WonMessageBuilder setPropertiesForPassingMessageToOwner(WonMessage externalMsg)

Deprecated.

setPropertiesForNodeResponse

public static WonMessageBuilder setPropertiesForNodeResponse(WonMessage originalMessage,
                                                             boolean isSuccess,
                                                             java.net.URI messageURI)

setSenderURI

public WonMessageBuilder setSenderURI(java.net.URI senderURI)

setSenderNeedURI

public WonMessageBuilder setSenderNeedURI(java.net.URI senderNeedURI)

setSenderNodeURI

public WonMessageBuilder setSenderNodeURI(java.net.URI senderNodeURI)

setReceiverURI

public WonMessageBuilder setReceiverURI(java.net.URI receiverURI)

setReceiverNeedURI

public WonMessageBuilder setReceiverNeedURI(java.net.URI receiverNeedURI)

setReceiverNodeURI

public WonMessageBuilder setReceiverNodeURI(java.net.URI receiverNodeURI)

setWonMessageType

public WonMessageBuilder setWonMessageType(WonMessageType wonMessageType)

setWonMessageDirection

public WonMessageBuilder setWonMessageDirection(WonMessageDirection wonMessageDirection)

addContent

public WonMessageBuilder addContent(org.apache.jena.rdf.model.Model content)

Adds the specified content graph, and the specified signature graph, using the specified contentURI as the graph name. The contentURI will be made unique inside the message dataset by appending characters at the end.

Parameters:

content -

Returns:

addContent

public WonMessageBuilder addContent(org.apache.jena.query.Dataset dataset)

Adds all graphs in the specified dataset as content graphs to the message. In this process, unique graph URIs are generated for all graphs in the dataset, including the default graph (if present). If graphs are referenced within the dataset through a triple in which the graph uri is the object, all such references are changed to refer to the newly generated graph uri.

Parameters:

dataset -

Returns:

getUnsignedContentGraph

public org.apache.jena.rdf.model.Model getUnsignedContentGraph()

Retrieves one of the possibly multiple Models that does not have a signature yet. If there is none (all are signed or none is found at all), a new model is created, added to the internal contentMap and returned here.

addRefersToURI

public WonMessageBuilder addRefersToURI(java.net.URI refersTo)

setIsResponseToMessageURI

public WonMessageBuilder setIsResponseToMessageURI(java.net.URI isResponseToMessageURI)

setIsRemoteResponseToMessageURI

public WonMessageBuilder setIsRemoteResponseToMessageURI(java.net.URI isRemoteResponseToMessageURI)

setIsResponseToMessageType

public WonMessageBuilder setIsResponseToMessageType(WonMessageType isResponseToMessageType)

setCorrespondingRemoteMessageURI

public WonMessageBuilder setCorrespondingRemoteMessageURI(java.net.URI correspondingRemoteMessageURI)

setForwardedMessageURI

public WonMessageBuilder setForwardedMessageURI(java.net.URI forwardedMessageURI)

setSentTimestamp

public WonMessageBuilder setSentTimestamp(long sentTimestamp)

setReceivedTimestamp

public WonMessageBuilder setReceivedTimestamp(java.lang.Long receivedTimestamp)

setSentTimestampToNow

public WonMessageBuilder setSentTimestampToNow()

setReceivedTimestampToNow

public WonMessageBuilder setReceivedTimestampToNow()

setTextMessage

public WonMessageBuilder setTextMessage(java.lang.String textMessage)

Adds a won:hasTextMessage triple to one of the unsigned content graphs in this builder. Creates a new unsigned content graph if none is found.

Parameters:

textMessage - may be null in which case the builder is not modified

Returns:

copyEnvelopeFromWonMessage

public static WonMessageBuilder copyEnvelopeFromWonMessage(WonMessage wonMessage)

Copies the envelope properties from the specified message to this message. Note that this does not copy the original envelope graph, only the standard envelope properties.

Parameters:

wonMessage -

Returns:

forwardReceivedNodeToNodeMessageAsNodeToNodeMessage

public static WonMessage forwardReceivedNodeToNodeMessageAsNodeToNodeMessage(java.net.URI newMessageUri,
                                                                             WonMessage wonMessage,
                                                                             java.net.URI connectionURI,
                                                                             java.net.URI needURI,
                                                                             java.net.URI wonNodeUri,
                                                                             java.net.URI remoteConnectionURI,
                                                                             java.net.URI remoteNeedURI,
                                                                             java.net.URI remoteWonNodeUri)