|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.fhhannover.inform.trust.ifmapj.messages.Requests
public class Requests
Provides access to Request
associated classes.
Nested Class Summary | |
---|---|
static class |
Requests.Helpers
This class provides helpers for custom request implementations. |
Method Summary | |
---|---|
static EndSessionRequest |
createEndSessionReq()
|
static NewSessionRequest |
createNewSessionReq()
|
static PollRequest |
createPollReq()
|
static PublishDelete |
createPublishDelete()
Create a new, empty PublishDelete instance. |
static PublishDelete |
createPublishDelete(Identifier i1)
Create a new PublishDelete instance for a specific Identifier
in order to delete all of its metadata. |
static PublishDelete |
createPublishDelete(Identifier i1,
Identifier i2)
Create a new PublishDelete instance for a link between two
Identifier instances in order to delete all metadata of the link. |
static PublishDelete |
createPublishDelete(Identifier i1,
Identifier i2,
String filter)
Create a new PublishDelete instance for a link between two
Identifier instances in order to delete its metadata that matches
the given filter. |
static PublishDelete |
createPublishDelete(Identifier i1,
String filter)
Create a new PublishDelete instance for a specific Identifier
in order to delete its metadata that matches the given filter. |
static PublishNotify |
createPublishNotify()
Create a new, empty PublishNotify instance. |
static PublishNotify |
createPublishNotify(Identifier i1,
Collection<Document> mdlist)
Create a new PublishNotify instance that is used to publish
a list of metadata instances. |
static PublishNotify |
createPublishNotify(Identifier i1,
Document md)
Create a new PublishNotify instance that is used to publish
metadata to an Identifier . |
static PublishNotify |
createPublishNotify(Identifier i1,
Identifier i2,
Collection<Document> mdlist)
Create a new PublishNotify instance that is used to publish
a list of metadata on a link between two Identifier instances. |
static PublishNotify |
createPublishNotify(Identifier i1,
Identifier i2,
Document md)
Create a new PublishNotify instance that is used to publish
metadata on a link between two Identifier instances. |
static PublishRequest |
createPublishReq()
Create an empty PublishRequest |
static PublishRequest |
createPublishReq(List<PublishElement> list)
Create a new PublishRequest that contains the given list of
PublishElement instances. |
static PublishRequest |
createPublishReq(PublishElement el)
Create a new PublishRequest that contains the given PublishElement |
static PublishUpdate |
createPublishUpdate()
|
static PublishUpdate |
createPublishUpdate(Identifier i1,
Collection<Document> mdlist)
Create a new PublishUpdate instance that is used to publish
a list of metadata instances. |
static PublishUpdate |
createPublishUpdate(Identifier i1,
Collection<Document> mdlist,
MetadataLifetime lifetime)
Create a new PublishUpdate instance that is used to publish
a list of metadata instances with a specific MetadataLifetime . |
static PublishUpdate |
createPublishUpdate(Identifier i1,
Document md)
Create a new PublishUpdate instance that is used to publish
metadata to an Identifier . |
static PublishUpdate |
createPublishUpdate(Identifier i1,
Document md,
MetadataLifetime lifetime)
Create a new PublishUpdate instance that is used to publish
metadata on an Identifier with a specific MetadataLifetime . |
static PublishUpdate |
createPublishUpdate(Identifier i1,
Identifier i2,
Collection<Document> mdlist)
Create a new PublishUpdate instance that is used to publish
a list of metadata on a link between two Identifier instances. |
static PublishUpdate |
createPublishUpdate(Identifier i1,
Identifier i2,
Collection<Document> mdlist,
MetadataLifetime lifetime)
Create a new PublishUpdate instance that is used to publish
a list of metadata on a link between two Identifier instances
with a specific MetadataLifetime . |
static PublishUpdate |
createPublishUpdate(Identifier i1,
Identifier i2,
Document md)
Create a new PublishUpdate instance that is used to publish
metadata on a link between two Identifier instances. |
static PublishUpdate |
createPublishUpdate(Identifier i1,
Identifier i2,
Document md,
MetadataLifetime lifetime)
Create a new PublishUpdate instance that is used to publish
metadata on a link between two Identifier instances with a specific
MetadataLifetime . |
static PurgePublisherRequest |
createPurgePublisherReq()
|
static RenewSessionRequest |
createRenewSessionReq()
|
static SearchRequest |
createSearchReq()
Create a SearchRequest with default values. |
static SearchRequest |
createSearchReq(String matchLinks,
Integer maxDepth,
String termIdents,
Integer maxSize,
String resultFilter,
Identifier start)
Create a new SearchRequest in order to perform an IF-MAP search. |
static SubscribeDelete |
createSubscribeDelete()
Create a SubscribeDelete instance with default values. |
static SubscribeDelete |
createSubscribeDelete(String name)
Create a new SubscribeDelete instance with the given name. |
static SubscribeRequest |
createSubscribeReq()
Create an empty SubscribeRequest |
static SubscribeRequest |
createSubscribeReq(List<SubscribeElement> list)
Create a SubscribeRequest with a list of SubscribeElement
instances. |
static SubscribeRequest |
createSubscribeReq(SubscribeElement el)
Create a SubscribeRequest with one SubscribeElement . |
static SubscribeUpdate |
createSubscribeUpdate()
Create a SubscribeUpdate instance with default values. |
static SubscribeUpdate |
createSubscribeUpdate(String name,
String matchLinks,
Integer maxDepth,
String termIdents,
Integer maxSize,
String resultFilter,
Identifier start)
Create a SubscribeUpdate instance with the given parameters. |
static RequestHandler<? extends Request> |
getHandlerFor(Request req)
|
static RequestFactory |
getRequestFactory()
Deprecated. Don't use. Will be gone soon. |
static void |
registerRequestHandler(RequestHandler<? extends Request> rh)
Register a custom request handler. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static void registerRequestHandler(RequestHandler<? extends Request> rh)
rh
- public static RequestHandler<? extends Request> getHandlerFor(Request req)
public static RequestFactory getRequestFactory()
public static PublishRequest createPublishReq()
PublishRequest
PublishRequest
public static PublishRequest createPublishReq(PublishElement el)
PublishRequest
that contains the given PublishElement
el
- the PublishElement
that is added to the new PublishRequest
PublishRequest
public static PublishRequest createPublishReq(List<PublishElement> list)
PublishRequest
that contains the given list of
PublishElement
instances.
list
- the list of PublishElement
instances that are added
to the new PublishRequest
PublishRequest
public static NewSessionRequest createNewSessionReq()
public static EndSessionRequest createEndSessionReq()
public static RenewSessionRequest createRenewSessionReq()
public static PurgePublisherRequest createPurgePublisherReq()
public static PollRequest createPollReq()
public static SubscribeRequest createSubscribeReq()
SubscribeRequest
SubscribeRequest
instancepublic static SubscribeRequest createSubscribeReq(SubscribeElement el)
SubscribeRequest
with one SubscribeElement
.
el
- the SubscribeElement
that is added to the new
SubscribeRequest
. This can either be SubscribeUpdate
or
SubscribeDelete
.
SubscribeRequest
public static SubscribeRequest createSubscribeReq(List<SubscribeElement> list)
SubscribeRequest
with a list of SubscribeElement
instances.
list
- the list of SubscribeElement
instances that are added
to the new SubscribeRequest
. The SubscribeElement
instances
are either SubscribeUpdate
or SubscribeDelete
instances.
SubscribeRequest
public static SearchRequest createSearchReq()
SearchRequest
with default values. You need to set at
least the start Identifier
with
SearchHolder.setStartIdentifier(Identifier)
afterwards!
SearchRequest
instancepublic static SearchRequest createSearchReq(String matchLinks, Integer maxDepth, String termIdents, Integer maxSize, String resultFilter, Identifier start)
SearchRequest
in order to perform an IF-MAP search.
matchLinks
- the match-links filter (null means match-all, an empty
String
means match-nothing)maxDepth
- max-depth of the search (default is left out)terminalIdentifiers
- comma separated list of terminal identifier
types (for example 'identity,device')maxSize
- max-size of search result (default is left out)resultFilter
- the result-filter filter (null means match-all, an
empty String
means match-nothing)start
- the start Identifier
SearchRequest
instancepublic static PublishUpdate createPublishUpdate()
PublishUpdate
instancepublic static PublishUpdate createPublishUpdate(Identifier i1, Document md)
PublishUpdate
instance that is used to publish
metadata to an Identifier
. The MetadataLifetime
of the
new metadata is set to MetadataLifetime.session
.
i1
- the Identifier
to which the given metadata is published tomd
- the metadata that shall be published
PublishUpdate
instancepublic static PublishUpdate createPublishUpdate(Identifier i1, Document md, MetadataLifetime lifetime)
PublishUpdate
instance that is used to publish
metadata on an Identifier
with a specific MetadataLifetime
.
i1
- the Identifier
to which the given metadata is published tomd
- the metadata that shall be publishedlifetime
- the lifetime of the new metadata
PublishUpdate
instancepublic static PublishUpdate createPublishUpdate(Identifier i1, Identifier i2, Document md)
PublishUpdate
instance that is used to publish
metadata on a link between two Identifier
instances. The
MetadataLifetime
of the new metadata is set to MetadataLifetime.session
.
i1
- the first Identifier
of the linki2
- the second Identifier
of the linkmd
- the metadata that shall be published
PublishUpdate
instancepublic static PublishUpdate createPublishUpdate(Identifier i1, Identifier i2, Document md, MetadataLifetime lifetime)
PublishUpdate
instance that is used to publish
metadata on a link between two Identifier
instances with a specific
MetadataLifetime
.
i1
- the first Identifier
of the linki2
- the second Identifier
of the linkmd
- the metadata that shall be publishedlifetime
- the lifetime of the new metadata
PublishUpdate
instancepublic static PublishUpdate createPublishUpdate(Identifier i1, Collection<Document> mdlist, MetadataLifetime lifetime)
PublishUpdate
instance that is used to publish
a list of metadata instances with a specific MetadataLifetime
.
i1
- the Identifier
to which the given metadata is published tomdlist
- a list of metadata objectslifetime
- the lifetime of the new metadata
PublishUpdate
instancepublic static PublishUpdate createPublishUpdate(Identifier i1, Collection<Document> mdlist)
PublishUpdate
instance that is used to publish
a list of metadata instances. The MetadataLifetime
of the new
metadata is set to MetadataLifetime.session
.
i1
- the Identifier
to which the given metadata is published tomdlist
- a list of metadata objects
PublishUpdate
instancepublic static PublishUpdate createPublishUpdate(Identifier i1, Identifier i2, Collection<Document> mdlist)
PublishUpdate
instance that is used to publish
a list of metadata on a link between two Identifier
instances.
The MetadataLifetime
of the new metadata is set to
MetadataLifetime.session
.
i1
- the first Identifier
of the linki2
- the second Identifier
of the linkmdlist
- a list of metadata objects
PublishUpdate
instancepublic static PublishUpdate createPublishUpdate(Identifier i1, Identifier i2, Collection<Document> mdlist, MetadataLifetime lifetime)
PublishUpdate
instance that is used to publish
a list of metadata on a link between two Identifier
instances
with a specific MetadataLifetime
.
i1
- the first Identifier
of the linki2
- the second Identifier
of the linkmdlist
- a list of metadata objectslifetime
- the lifetime of the new metadata
PublishUpdate
instancepublic static PublishNotify createPublishNotify()
PublishNotify
instance.
PublishNotify
instancepublic static PublishNotify createPublishNotify(Identifier i1, Document md)
PublishNotify
instance that is used to publish
metadata to an Identifier
.
i1
- the Identifier
to which the given metadata is published tomd
- the metadata that shall be published
PublishNotify
instancepublic static PublishNotify createPublishNotify(Identifier i1, Collection<Document> mdlist)
PublishNotify
instance that is used to publish
a list of metadata instances.
i1
- the Identifier
to which the given metadata is published tomdlist
- a list of metadata objects
PublishNotify
instancepublic static PublishNotify createPublishNotify(Identifier i1, Identifier i2, Document md)
PublishNotify
instance that is used to publish
metadata on a link between two Identifier
instances.
i1
- the first Identifier
of the linki2
- the second Identifier
of the linkmd
- the metadata that shall be published
PublishNotify
instancepublic static PublishNotify createPublishNotify(Identifier i1, Identifier i2, Collection<Document> mdlist)
PublishNotify
instance that is used to publish
a list of metadata on a link between two Identifier
instances.
The MetadataLifetime
of the new metadata is set to
MetadataLifetime.session
.
i1
- the first Identifier
of the linki2
- the second Identifier
of the linkmdlist
- a list of metadata objects
PublishNotify
instancepublic static PublishDelete createPublishDelete()
PublishDelete
instance.
PublishDelete
instancepublic static PublishDelete createPublishDelete(Identifier i1)
PublishDelete
instance for a specific Identifier
in order to delete all of its metadata.
i1
- the Identifier
that is the target of the delete request
PublishDelete
instancepublic static PublishDelete createPublishDelete(Identifier i1, Identifier i2)
PublishDelete
instance for a link between two
Identifier
instances in order to delete all metadata of the link.
i1
- the first Identifier
of the linki2
- the second Identifier
of the link
PublishDelete
instancepublic static PublishDelete createPublishDelete(Identifier i1, String filter)
PublishDelete
instance for a specific Identifier
in order to delete its metadata that matches the given filter.
i1
- the Identifier
that is the target of the delete requestfilter
- a filter that expresses the metadata that shall be deleted
PublishDelete
instancepublic static PublishDelete createPublishDelete(Identifier i1, Identifier i2, String filter)
PublishDelete
instance for a link between two
Identifier
instances in order to delete its metadata that matches
the given filter.
i1
- the first Identifier
of the linki2
- the second Identifier
of the linkfilter
- a filter that expresses the metadata that shall be deleted
PublishDelete
instancepublic static SubscribeUpdate createSubscribeUpdate()
SubscribeUpdate
instance with default values. You need
to add the start Identifier
with
SearchHolder.setStartIdentifier(Identifier)
and the name with
SubscribeElement.setName(String)
afterwards!
SubscribeUpdate
instancepublic static SubscribeUpdate createSubscribeUpdate(String name, String matchLinks, Integer maxDepth, String termIdents, Integer maxSize, String resultFilter, Identifier start)
SubscribeUpdate
instance with the given parameters.
name
- the name of the subscriptionmatchLinks
- the match-links filter (null means match-all, an empty
String
means match-nothing)maxDepth
- max-depth of the search (default is left out)terminalIdentifiers
- comma separated list of terminal identifier
types (for example 'identity,device')maxSize
- max-size of search result (default is left out)resultFilter
- the result-filter filter (null means match-all, an
empty String
means match-nothing)start
- the start Identifier
SubscribeUpdate
instancepublic static SubscribeDelete createSubscribeDelete()
SubscribeDelete
instance with default values. You need
to set the name with SubscribeElement.setName(String)
afterwards!
SubscribeDelete
instancepublic static SubscribeDelete createSubscribeDelete(String name)
SubscribeDelete
instance with the given name.
name
- the name of the subscription that shall be deleted on the
MAPS.
SubscribeDelete
instance
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |