won.protocol.service

Interface WonNodeInformationService

All Known Implementing Classes:

WonNodeInformationServiceDecorator, WonNodeInformationServiceImpl

public interface WonNodeInformationService

Service for managing won node related information and for generating URIs required for messaging and creation of resources.

Method Summary

Modifier and Type	Method and Description
java.net.URI	generateAtomURI() Generates a random atom URI according to the URI pattern of the default won node.
java.net.URI	generateAtomURI(java.net.URI wonNodeURI) Generates a random atom URI according to the URI pattern of the specified won node.
java.net.URI	generateConnectionURI(java.net.URI atomURI) Generates a previously unused connection URI at random as the concatenation of atomURI + '/c/[id]', where atomURI is the specified atom URI, which must conform to the node's prefixes, and [id] is a randomly generated alphanumeric identifier.
WonNodeInfo	getDefaultWonNodeInfo()
java.net.URI	getDefaultWonNodeURI()
WonNodeInfo	getWonNodeInformation(java.net.URI wonNodeURI) Get the WonNodeInfo that is uniquely identified by the specified wonNodeURI.
java.util.Optional<WonNodeInfo>	getWonNodeInformationForURI(java.net.URI someURI, java.util.Optional<java.net.URI> requesterWebID) Given someURI, try different methods to find a WoN node which is responsible for it.
java.net.URI	getWonNodeUri(java.net.URI resourceURI) Obtains the won node uri associated with the specified atom or connection resource.
boolean	isValidAtomURI(java.net.URI atomURI) Checks if the passed atom URI is matching the won default node pattern
boolean	isValidAtomURI(java.net.URI atomURI, java.net.URI wonNodeURI) Checks if the passed atom URI is matching the won node pattern
boolean	isValidConnectionURI(java.net.URI connectionURI) Checks if the passed connection URI is matching the won default node pattern
boolean	isValidConnectionURI(java.net.URI connectionURI, java.net.URI wonNodeURI) Checks if the passed event URI is matching the won node pattern
boolean	isValidEventURI(java.net.URI eventURI) Checks if the passed event URI is matching the won node default pattern
boolean	isValidEventURI(java.net.URI eventURI, java.net.URI wonNodeURI) Checks if the passed event URI is matching the won node pattern

Method Detail

getWonNodeInformation

WonNodeInfo getWonNodeInformation(java.net.URI wonNodeURI)

Get the WonNodeInfo that is uniquely identified by the specified wonNodeURI.

Parameters:

wonNodeURI -

Returns:

getWonNodeInformationForURI

java.util.Optional<WonNodeInfo> getWonNodeInformationForURI(java.net.URI someURI,
                                                            java.util.Optional<java.net.URI> requesterWebID)

Given someURI, try different methods to find a WoN node which is responsible for it.

Parameters:

someURI -

Returns:

isValidEventURI

boolean isValidEventURI(java.net.URI eventURI)

Checks if the passed event URI is matching the won node default pattern

Parameters:

eventURI -

Returns:

isValidEventURI

boolean isValidEventURI(java.net.URI eventURI,
                        java.net.URI wonNodeURI)

Checks if the passed event URI is matching the won node pattern

Parameters:

eventURI -

wonNodeURI -

Returns:

generateConnectionURI

java.net.URI generateConnectionURI(java.net.URI atomURI)

Generates a previously unused connection URI at random as the concatenation of atomURI + '/c/[id]', where atomURI is the specified atom URI, which must conform to the node's prefixes, and [id] is a randomly generated alphanumeric identifier.

Parameters:

atomURI -

Returns:

isValidConnectionURI

boolean isValidConnectionURI(java.net.URI connectionURI)

Checks if the passed connection URI is matching the won default node pattern

Parameters:

connectionURI -

Returns:

isValidConnectionURI

boolean isValidConnectionURI(java.net.URI connectionURI,
                             java.net.URI wonNodeURI)

Checks if the passed event URI is matching the won node pattern

Parameters:

connectionURI -

wonNodeURI -

Returns:

generateAtomURI

java.net.URI generateAtomURI()

Generates a random atom URI according to the URI pattern of the default won node.

Returns:

generateAtomURI

java.net.URI generateAtomURI(java.net.URI wonNodeURI)

Generates a random atom URI according to the URI pattern of the specified won node.

Parameters:

wonNodeURI -

Returns:

isValidAtomURI

boolean isValidAtomURI(java.net.URI atomURI)

Checks if the passed atom URI is matching the won default node pattern

Parameters:

atomURI -

Returns:

isValidAtomURI

boolean isValidAtomURI(java.net.URI atomURI,
                       java.net.URI wonNodeURI)

Checks if the passed atom URI is matching the won node pattern

Parameters:

atomURI -

wonNodeURI -

Returns:

getDefaultWonNodeURI

java.net.URI getDefaultWonNodeURI()

getDefaultWonNodeInfo

WonNodeInfo getDefaultWonNodeInfo()

getWonNodeUri

java.net.URI getWonNodeUri(java.net.URI resourceURI)

Obtains the won node uri associated with the specified atom or connection resource.

Parameters:

resourceURI -

Returns:

the won node URI or null if none is found.