won.protocol.service

Interface AtomInformationService

public interface AtomInformationService

Service for obtaining information about atoms and connections in the system in RDF.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AtomInformationService.PagedResource<T,E>

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.net.URI>	listAtomURIs() Retrieves a list of all atoms on the atomserver.
org.springframework.data.domain.Slice<java.net.URI>	listAtomURIs(int page, java.lang.Integer preferredSize, AtomState atomState) Retrieves a page of the list of atoms on the atomserver that have a given state with number of atom uris per page preference.
org.springframework.data.domain.Slice<java.net.URI>	listAtomURIsAfter(java.net.URI atom, java.lang.Integer preferredSize, AtomState atomState) Retrieves list of atoms on the atomserver that where created later than the given atom that have a given state with number of atom uris per page preference.
org.springframework.data.domain.Slice<java.net.URI>	listAtomURIsBefore(java.net.URI atom, java.lang.Integer preferredSize, AtomState atomState) Retrieves list of atoms on the atomserver that where created earlier than the given atom that have a given state with number of atom uris per page preference.
org.springframework.data.domain.Slice<MessageEventPlaceholder>	listConnectionEvents(java.net.URI connectionUri, int page, java.lang.Integer preferredPageSize, WonMessageType messageType)
org.springframework.data.domain.Slice<MessageEventPlaceholder>	listConnectionEventsAfter(java.net.URI connectionUri, java.net.URI msgURI, java.lang.Integer preferredPageSize, WonMessageType msgType)
org.springframework.data.domain.Slice<MessageEventPlaceholder>	listConnectionEventsBefore(java.net.URI connectionUri, java.net.URI msgURI, java.lang.Integer preferredPageSize, WonMessageType msgType)
java.util.Collection<Connection>	listConnections() Retrieves all connections (regardless of state).
org.springframework.data.domain.Slice<Connection>	listConnections(int page, java.lang.Integer preferredSize, java.util.Date timeSpot) Retrieves slice of the connection URIs list for a given page number
java.util.Collection<Connection>	listConnections(java.net.URI atomURI) Retrieves all connections (regardless of state) for the specified local atom URI.
org.springframework.data.domain.Slice<Connection>	listConnections(java.net.URI atomURI, int page, java.lang.Integer preferredSize, WonMessageType messageType, java.util.Date timeSpot) Retrieves slice of the list of connections for the specified local atom URI.
org.springframework.data.domain.Slice<Connection>	listConnectionsAfter(java.net.URI resumeConnURI, java.lang.Integer preferredPageSize, java.util.Date timeSpot) Retrieves slice of the connections that follows the given connection URI from the point of view of their latest events.
org.springframework.data.domain.Slice	listConnectionsAfter(java.net.URI atomURI, java.net.URI resumeConnURI, java.lang.Integer preferredPageSize, WonMessageType messageType, java.util.Date timeSpot) Retrieves slice of the connections that follows the given connection URI from the point of view of their latest events.
org.springframework.data.domain.Slice<Connection>	listConnectionsBefore(java.net.URI resumeConnURI, java.lang.Integer preferredPageSize, java.util.Date timeSpot) Retrieves slice of the connections that precede the given connection URI from the point of view of their latest events.
org.springframework.data.domain.Slice	listConnectionsBefore(java.net.URI atomURI, java.net.URI resumeConnURI, java.lang.Integer preferredPageSize, WonMessageType messageType, java.util.Date timeSpot) Retrieves slice of the connections for the specified local atom URI that precede the given connection URI from the point of view of their latest events.
java.util.Collection<java.net.URI>	listConnectionURIs() Retrieves all connection URIs (regardless of state).
org.springframework.data.domain.Slice<java.net.URI>	listConnectionURIs(int page, java.lang.Integer preferredSize, java.util.Date timeSpot) Retrieves slice of the connection URIs list for a given page number
java.util.Collection<java.net.URI>	listConnectionURIs(java.net.URI atomURI) Retrieves all connection URIs (regardless of state) for the specified local atom URI.
org.springframework.data.domain.Slice<java.net.URI>	listConnectionURIs(java.net.URI atomURI, int page, java.lang.Integer preferredSize, WonMessageType messageType, java.util.Date timeSpot) Retrieves slice of the list of connection URIs for the specified local atom URI.
java.util.Collection<java.net.URI>	listModifiedAtomURIsAfter(java.util.Date modifiedAfter) retrieves atoms that have been modified after a certain date
java.util.Collection<Connection>	listModifiedConnectionsAfter(java.util.Date modifiedAfter) Retrieves all connections that were modified (by adding events) after a certain date
Atom	readAtom(java.net.URI atomURI) Read general information about the atom.
DataWithEtag<Atom>	readAtom(java.net.URI atomURI, java.lang.String etag) read atom data including if atom version number is equal to etag
org.apache.jena.rdf.model.Model	readAtomContent(java.net.URI atomURI) Retrieves the public description of the atom as an RDF graph.
Connection	readConnection(java.net.URI connectionURI) Read general information about the connection.
DataWithEtag<Connection>	readConnection(java.net.URI connectionURI, java.lang.String Etag) read connection data including etag if connection version number is equal to etag
org.apache.jena.rdf.model.Model	readConnectionContent(java.net.URI connectionURI) Retrieves the public description of the connection as an RDF graph.

Method Detail

listAtomURIs

java.util.Collection<java.net.URI> listAtomURIs()

Retrieves a list of all atoms on the atomserver.

Returns:

a collection of all atom URIs.

listAtomURIs

org.springframework.data.domain.Slice<java.net.URI> listAtomURIs(int page,
                                                                 java.lang.Integer preferredSize,
                                                                 AtomState atomState)

Retrieves a page of the list of atoms on the atomserver that have a given state with number of atom uris per page preference.

Parameters:

page - the page number

preferredSize - preferred number of members per page, null => use default

atomState - Active/Inactive, null => all states

Returns:

a collection of all atom URIs.

listAtomURIsBefore

org.springframework.data.domain.Slice<java.net.URI> listAtomURIsBefore(java.net.URI atom,
                                                                       java.lang.Integer preferredSize,
                                                                       AtomState atomState)

Retrieves list of atoms on the atomserver that where created earlier than the given atom that have a given state with number of atom uris per page preference.

Parameters:

atom -

preferredSize - preferred number of members per page, null => use default

atomState - Active/Inactive, null => all states

Returns:

a collection of all atom URIs.

listAtomURIsAfter

org.springframework.data.domain.Slice<java.net.URI> listAtomURIsAfter(java.net.URI atom,
                                                                      java.lang.Integer preferredSize,
                                                                      AtomState atomState)

Retrieves list of atoms on the atomserver that where created later than the given atom that have a given state with number of atom uris per page preference.

Parameters:

atom -

preferredSize - preferred number of members per page, null => use default

atomState - Active/Inactive, null => all states

Returns:

a collection of all atom URIs.

listModifiedAtomURIsAfter

java.util.Collection<java.net.URI> listModifiedAtomURIsAfter(java.util.Date modifiedAfter)

retrieves atoms that have been modified after a certain date

Parameters:

modifiedAfter - modification date of the atoms to retrieve

Returns:

collection of modified atoms

listConnectionURIs

java.util.Collection<java.net.URI> listConnectionURIs()

Retrieves all connection URIs (regardless of state).

Returns:

a collection of connection URIs.

listConnections

java.util.Collection<Connection> listConnections()

Retrieves all connections (regardless of state).

Returns:

a collection of connections.

listModifiedConnectionsAfter

java.util.Collection<Connection> listModifiedConnectionsAfter(java.util.Date modifiedAfter)

Retrieves all connections that were modified (by adding events) after a certain date

Parameters:

modifiedAfter - modification date

Returns:

listConnectionURIs

org.springframework.data.domain.Slice<java.net.URI> listConnectionURIs(int page,
                                                                       java.lang.Integer preferredSize,
                                                                       java.util.Date timeSpot)

Retrieves slice of the connection URIs list for a given page number

Parameters:

page - the page number

preferredSize - preferred number of members per page or null; null => use default

timeSpot - time at which we want the list state to be fixed, if null - current state

Returns:

a slice connection URIs.

listConnections

org.springframework.data.domain.Slice<Connection> listConnections(int page,
                                                                  java.lang.Integer preferredSize,
                                                                  java.util.Date timeSpot)

Retrieves slice of the connection URIs list for a given page number

Parameters:

page - the page number

preferredSize - preferred number of members per page or null; null => use default

timeSpot - time at which we want the list state to be fixed, if null - current state

Returns:

a slice connection URIs.

listConnectionsBefore

org.springframework.data.domain.Slice<Connection> listConnectionsBefore(java.net.URI resumeConnURI,
                                                                        java.lang.Integer preferredPageSize,
                                                                        java.util.Date timeSpot)

Retrieves slice of the connections that precede the given connection URI from the point of view of their latest events.

Parameters:

resumeConnURI - the returned slice connections precede (in time of their latest events) this connection uri

preferredPageSize - preferred number of members per page or null; null => use default

timeSpot - time at which we want the list state to be fixed, cannot be null

Returns:

a slice of connection URIs.

listConnectionsAfter

org.springframework.data.domain.Slice<Connection> listConnectionsAfter(java.net.URI resumeConnURI,
                                                                       java.lang.Integer preferredPageSize,
                                                                       java.util.Date timeSpot)

Retrieves slice of the connections that follows the given connection URI from the point of view of their latest events.

Parameters:

resumeConnURI - the returned slice connections follow (in time of their latest events) this connection uri

preferredPageSize - preferred number of members per page or null; null => use default

timeSpot - time at which we want the list state to be fixed, cannot be null

Returns:

a slice of connection URIs.

listConnectionURIs

java.util.Collection<java.net.URI> listConnectionURIs(java.net.URI atomURI)
                                               throws NoSuchAtomException

Retrieves all connection URIs (regardless of state) for the specified local atom URI.

Parameters:

atomURI - the URI of the atom

Returns:

a collection of connection URIs.

Throws:

NoSuchAtomException - if atomURI is not a known atom URI

listConnections

java.util.Collection<Connection> listConnections(java.net.URI atomURI)
                                          throws NoSuchAtomException

Retrieves all connections (regardless of state) for the specified local atom URI.

Parameters:

atomURI - the URI of the atom

Returns:

a collection of connections.

Throws:

NoSuchAtomException - if atomURI is not a known atom URI

listConnectionURIs

org.springframework.data.domain.Slice<java.net.URI> listConnectionURIs(java.net.URI atomURI,
                                                                       int page,
                                                                       java.lang.Integer preferredSize,
                                                                       WonMessageType messageType,
                                                                       java.util.Date timeSpot)

Retrieves slice of the list of connection URIs for the specified local atom URI.

Parameters:

atomURI - the URI of the atom

page - the page number

preferredSize - preferred number of members per page or null; null => use default

messageType - event type that should be used for defining connection latest activity; null => all event types

timeSpot - time at which we want the list state to be fixed, if null - current state

Returns:

a collection of connection URIs.

Throws:

NoSuchAtomException - if atomURI is not a known atom URI

listConnections

org.springframework.data.domain.Slice<Connection> listConnections(java.net.URI atomURI,
                                                                  int page,
                                                                  java.lang.Integer preferredSize,
                                                                  WonMessageType messageType,
                                                                  java.util.Date timeSpot)

Retrieves slice of the list of connections for the specified local atom URI.

Parameters:

atomURI - the URI of the atom

page - the page number

preferredSize - preferred number of members per page or null; null => use default

messageType - event type that should be used for defining connection latest activity; null => all event types

timeSpot - time at which we want the list state to be fixed, if null - current state

Returns:

a collection of connections.

Throws:

NoSuchAtomException - if atomURI is not a known atom URI

listConnectionsBefore

org.springframework.data.domain.Slice listConnectionsBefore(java.net.URI atomURI,
                                                            java.net.URI resumeConnURI,
                                                            java.lang.Integer preferredPageSize,
                                                            WonMessageType messageType,
                                                            java.util.Date timeSpot)

Retrieves slice of the connections for the specified local atom URI that precede the given connection URI from the point of view of their latest events.

Parameters:

resumeConnURI - the returned slice connections precede (in time of their latest events) this connection uri

preferredPageSize - preferred number of members per page or null; null => use default

messageType - event type that should be used for defining connection latest activity; null => all event types

timeSpot - time at which we want the list state to be fixed, cannot be null

Returns:

a slice of connection URIs.

listConnectionsAfter

org.springframework.data.domain.Slice listConnectionsAfter(java.net.URI atomURI,
                                                           java.net.URI resumeConnURI,
                                                           java.lang.Integer preferredPageSize,
                                                           WonMessageType messageType,
                                                           java.util.Date timeSpot)

Retrieves slice of the connections that follows the given connection URI from the point of view of their latest events.

Parameters:

resumeConnURI - the returned slice connections follow (in time of their latest events) this connection uri

preferredPageSize - preferred number of members per page or null; null => use default

messageType - event type that should be used for defining connection latest activity; null => all event types

timeSpot - time at which we want the list state to be fixed, cannot be null

Returns:

a slice of connection URIs.

readAtom

Atom readAtom(java.net.URI atomURI)
       throws NoSuchAtomException

Read general information about the atom.

Parameters:

atomURI -

Returns:

Throws:

NoSuchAtomException

readAtom

DataWithEtag<Atom> readAtom(java.net.URI atomURI,
                            java.lang.String etag)
                     throws NoSuchAtomException

read atom data including if atom version number is equal to etag

Parameters:

atomURI - describes the atom to lookup

etag - describes the version of the data to look up

Returns:

atom data with corresponding etag version number or null if no atom with the specified URI or the version number of the etag is found

Throws:

NoSuchAtomException

readAtomContent

org.apache.jena.rdf.model.Model readAtomContent(java.net.URI atomURI)
                                         throws NoSuchAtomException

Retrieves the public description of the atom as an RDF graph.

Parameters:

atomURI -

Returns:

Throws:

NoSuchAtomException

readConnection

Connection readConnection(java.net.URI connectionURI)
                   throws NoSuchConnectionException

Read general information about the connection.

Parameters:

connectionURI -

Returns:

Throws:

NoSuchAtomException

NoSuchConnectionException

readConnection

DataWithEtag<Connection> readConnection(java.net.URI connectionURI,
                                        java.lang.String Etag)

read connection data including etag if connection version number is equal to etag

Parameters:

connectionURI - describes the connection to lookup

Etag - describes the version of the data to look up

Returns:

connection data with corresponding etag version number or null if no atom with the specified URI or the version number of the etag is found

readConnectionContent

org.apache.jena.rdf.model.Model readConnectionContent(java.net.URI connectionURI)
                                               throws NoSuchConnectionException

Retrieves the public description of the connection as an RDF graph.

Parameters:

connectionURI -

Returns:

Throws:

NoSuchAtomException

NoSuchConnectionException

listConnectionEvents

org.springframework.data.domain.Slice<MessageEventPlaceholder> listConnectionEvents(java.net.URI connectionUri,
                                                                                    int page,
                                                                                    java.lang.Integer preferredPageSize,
                                                                                    WonMessageType messageType)

listConnectionEventsBefore

org.springframework.data.domain.Slice<MessageEventPlaceholder> listConnectionEventsBefore(java.net.URI connectionUri,
                                                                                          java.net.URI msgURI,
                                                                                          java.lang.Integer preferredPageSize,
                                                                                          WonMessageType msgType)

listConnectionEventsAfter

org.springframework.data.domain.Slice<MessageEventPlaceholder> listConnectionEventsAfter(java.net.URI connectionUri,
                                                                                         java.net.URI msgURI,
                                                                                         java.lang.Integer preferredPageSize,
                                                                                         WonMessageType msgType)