de.fhhannover.inform.trust.ifmapj.messages
Interface RequestFactory


Deprecated. Use Requests directly to create differen Request implementations.

public interface RequestFactory

Factory in order to create any IF-MAP request message.
For PublishUpdate: If no lifetime is given, it's session.
For PublishDelete: If no filter string is given, it is left out --> match all
For Search/Subscribe: Setting same parameters to NULL leaves those parameters out.

Author:
aw, ib

Method Summary
 PublishDelete createPublishDelete()
          Deprecated. Create a new, empty PublishDelete instance.
 PublishDelete createPublishDelete(Identifier i1)
          Deprecated. Create a new PublishDelete instance for a specific Identifier in order to delete all of its metadata.
 PublishDelete createPublishDelete(Identifier i1, Identifier i2)
          Deprecated. Create a new PublishDelete instance for a link between two Identifier instances in order to delete all metadata of the link.
 PublishDelete createPublishDelete(Identifier i1, Identifier i2, String filter)
          Deprecated. Create a new PublishDelete instance for a link between two Identifier instances in order to delete its metadata that matches the given filter.
 PublishDelete createPublishDelete(Identifier i1, String filter)
          Deprecated. Create a new PublishDelete instance for a specific Identifier in order to delete its metadata that matches the given filter.
 PublishNotify createPublishNotify()
          Deprecated. Create a new, empty PublishNotify instance.
 PublishNotify createPublishNotify(Identifier i1, Collection<Document> mdlist)
          Deprecated. Create a new PublishNotify instance that is used to publish a list of metadata instances.
 PublishNotify createPublishNotify(Identifier i1, Document md)
          Deprecated. Create a new PublishNotify instance that is used to publish metadata to an Identifier.
 PublishNotify createPublishNotify(Identifier i1, Identifier i2, Collection<Document> mdlist)
          Deprecated. Create a new PublishNotify instance that is used to publish a list of metadata on a link between two Identifier instances.
 PublishNotify createPublishNotify(Identifier i1, Identifier i2, Document md)
          Deprecated. Create a new PublishNotify instance that is used to publish metadata on a link between two Identifier instances.
 PublishRequest createPublishReq()
          Deprecated. Create an empty PublishRequest
 PublishRequest createPublishReq(Collection<PublishElement> list)
          Deprecated. Create a new PublishRequest that contains the given list of PublishElement instances.
 PublishRequest createPublishReq(PublishElement el)
          Deprecated. Create a new PublishRequest that contains the given PublishElement
 PublishUpdate createPublishUpdate()
          Deprecated. Create a new, empty PublishUpdate instance.
 PublishUpdate createPublishUpdate(Identifier i1, Collection<Document> mdlist)
          Deprecated. Create a new PublishUpdate instance that is used to publish a list of metadata instances.
 PublishUpdate createPublishUpdate(Identifier i1, Collection<Document> mdlist, MetadataLifetime lifetime)
          Deprecated. Create a new PublishUpdate instance that is used to publish a list of metadata instances with a specific MetadataLifetime.
 PublishUpdate createPublishUpdate(Identifier i1, Document md)
          Deprecated. Create a new PublishUpdate instance that is used to publish metadata to an Identifier.
 PublishUpdate createPublishUpdate(Identifier i1, Document md, MetadataLifetime lifetime)
          Deprecated. Create a new PublishUpdate instance that is used to publish metadata on an Identifier with a specific MetadataLifetime.
 PublishUpdate createPublishUpdate(Identifier i1, Identifier i2, Collection<Document> mdlist)
          Deprecated. Create a new PublishUpdate instance that is used to publish a list of metadata on a link between two Identifier instances.
 PublishUpdate createPublishUpdate(Identifier i1, Identifier i2, Collection<Document> mdlist, MetadataLifetime lifetime)
          Deprecated. 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.
 PublishUpdate createPublishUpdate(Identifier i1, Identifier i2, Document md)
          Deprecated. Create a new PublishUpdate instance that is used to publish metadata on a link between two Identifier instances.
 PublishUpdate createPublishUpdate(Identifier i1, Identifier i2, Document md, MetadataLifetime lifetime)
          Deprecated. Create a new PublishUpdate instance that is used to publish metadata on a link between two Identifier instances with a specific MetadataLifetime.
 SearchRequest createSearchRequest()
          Deprecated. Create a SearchRequest with default values.
 SearchRequest createSearchRequest(String matchLinks, Integer maxDepth, String terminalIdentifiers, Integer maxSize, String resultFilter, Identifier start)
          Deprecated. Create a new SearchRequest in order to perform an IF-MAP search.
 SubscribeDelete createSubscribeDelete()
          Deprecated. Create a SubscribeDelete instance with default values.
 SubscribeDelete createSubscribeDelete(String name)
          Deprecated. Create a new SubscribeDelete instance with the given name.
 SubscribeRequest createSubscribeReq()
          Deprecated. Create an empty SubscribeRequest
 SubscribeRequest createSubscribeReq(List<SubscribeElement> list)
          Deprecated. Create a SubscribeRequest with a list of SubscribeElement instances.
 SubscribeRequest createSubscribeReq(SubscribeElement el)
          Deprecated. Create a SubscribeRequest with one SubscribeElement.
 SubscribeUpdate createSubscribeUpdate()
          Deprecated. Create a SubscribeUpdate instance with default values.
 SubscribeUpdate createSubscribeUpdate(String name, String matchLinks, Integer maxDepth, String terminalIdentifiers, Integer maxSize, String resultFilter, Identifier start)
          Deprecated. Create a SubscribeUpdate instance with the given parameters.
 

Method Detail

createPublishReq

PublishRequest createPublishReq()
Deprecated. 
Create an empty PublishRequest

Returns:
the new PublishRequest

createPublishReq

PublishRequest createPublishReq(PublishElement el)
Deprecated. 
Create a new PublishRequest that contains the given PublishElement

Parameters:
el - the PublishElement that is added to the new PublishRequest
Returns:
the new PublishRequest

createPublishReq

PublishRequest createPublishReq(Collection<PublishElement> list)
Deprecated. 
Create a new PublishRequest that contains the given list of PublishElement instances.

Parameters:
list - the list of PublishElement instances that are added to the new PublishRequest
Returns:
the new PublishRequest

createPublishUpdate

PublishUpdate createPublishUpdate()
Deprecated. 
Create a new, empty PublishUpdate instance.

Returns:
the new PublishUpdate instance

createPublishUpdate

PublishUpdate createPublishUpdate(Identifier i1,
                                  Document md)
Deprecated. 
Create a new PublishUpdate instance that is used to publish metadata to an Identifier. The MetadataLifetime of the new metadata is set to MetadataLifetime.session.

Parameters:
i1 - the Identifier to which the given metadata is published to
md - the metadata that shall be published
Returns:
the new PublishUpdate instance

createPublishUpdate

PublishUpdate createPublishUpdate(Identifier i1,
                                  Document md,
                                  MetadataLifetime lifetime)
Deprecated. 
Create a new PublishUpdate instance that is used to publish metadata on an Identifier with a specific MetadataLifetime.

Parameters:
i1 - the Identifier to which the given metadata is published to
md - the metadata that shall be published
lifetime - the lifetime of the new metadata
Returns:
the new PublishUpdate instance

createPublishUpdate

PublishUpdate createPublishUpdate(Identifier i1,
                                  Identifier i2,
                                  Document md)
Deprecated. 
Create a new 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.

Parameters:
i1 - the first Identifier of the link
i2 - the second Identifier of the link
md - the metadata that shall be published
Returns:
the new PublishUpdate instance

createPublishUpdate

PublishUpdate createPublishUpdate(Identifier i1,
                                  Identifier i2,
                                  Document md,
                                  MetadataLifetime lifetime)
Deprecated. 
Create a new PublishUpdate instance that is used to publish metadata on a link between two Identifier instances with a specific MetadataLifetime.

Parameters:
i1 - the first Identifier of the link
i2 - the second Identifier of the link
md - the metadata that shall be published
lifetime - the lifetime of the new metadata
Returns:
the new PublishUpdate instance

createPublishUpdate

PublishUpdate createPublishUpdate(Identifier i1,
                                  Collection<Document> mdlist)
Deprecated. 
Create a new PublishUpdate instance that is used to publish a list of metadata instances. The MetadataLifetime of the new metadata is set to MetadataLifetime.session.

Parameters:
i1 - the Identifier to which the given metadata is published to
mdlist - a list of metadata objects
Returns:
the new PublishUpdate instance

createPublishUpdate

PublishUpdate createPublishUpdate(Identifier i1,
                                  Collection<Document> mdlist,
                                  MetadataLifetime lifetime)
Deprecated. 
Create a new PublishUpdate instance that is used to publish a list of metadata instances with a specific MetadataLifetime.

Parameters:
i1 - the Identifier to which the given metadata is published to
mdlist - a list of metadata objects
lifetime - the lifetime of the new metadata
Returns:
the new PublishUpdate instance

createPublishUpdate

PublishUpdate createPublishUpdate(Identifier i1,
                                  Identifier i2,
                                  Collection<Document> mdlist)
Deprecated. 
Create a new 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.

Parameters:
i1 - the first Identifier of the link
i2 - the second Identifier of the link
mdlist - a list of metadata objects
Returns:
the new PublishUpdate instance

createPublishUpdate

PublishUpdate createPublishUpdate(Identifier i1,
                                  Identifier i2,
                                  Collection<Document> mdlist,
                                  MetadataLifetime lifetime)
Deprecated. 
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.

Parameters:
i1 - the first Identifier of the link
i2 - the second Identifier of the link
mdlist - a list of metadata objects
lifetime - the lifetime of the new metadata
Returns:
the new PublishUpdate instance

createPublishDelete

PublishDelete createPublishDelete()
Deprecated. 
Create a new, empty PublishDelete instance.

Returns:
the new PublishDelete instance

createPublishDelete

PublishDelete createPublishDelete(Identifier i1)
Deprecated. 
Create a new PublishDelete instance for a specific Identifier in order to delete all of its metadata.

Parameters:
i1 - the Identifier that is the target of the delete request
Returns:
the new PublishDelete instance

createPublishDelete

PublishDelete createPublishDelete(Identifier i1,
                                  Identifier i2)
Deprecated. 
Create a new PublishDelete instance for a link between two Identifier instances in order to delete all metadata of the link.

Parameters:
i1 - the first Identifier of the link
i2 - the second Identifier of the link
Returns:
the new PublishDelete instance

createPublishDelete

PublishDelete createPublishDelete(Identifier i1,
                                  String filter)
Deprecated. 
Create a new PublishDelete instance for a specific Identifier in order to delete its metadata that matches the given filter.

Parameters:
i1 - the Identifier that is the target of the delete request
filter - a filter that expresses the metadata that shall be deleted
Returns:
the new PublishDelete instance

createPublishDelete

PublishDelete createPublishDelete(Identifier i1,
                                  Identifier i2,
                                  String filter)
Deprecated. 
Create a new PublishDelete instance for a link between two Identifier instances in order to delete its metadata that matches the given filter.

Parameters:
i1 - the first Identifier of the link
i2 - the second Identifier of the link
filter - a filter that expresses the metadata that shall be deleted
Returns:
the new PublishDelete instance

createPublishNotify

PublishNotify createPublishNotify()
Deprecated. 
Create a new, empty PublishNotify instance.

Returns:
the new PublishNotify instance

createPublishNotify

PublishNotify createPublishNotify(Identifier i1,
                                  Document md)
Deprecated. 
Create a new PublishNotify instance that is used to publish metadata to an Identifier.

Parameters:
i1 - the Identifier to which the given metadata is published to
md - the metadata that shall be published
Returns:
the new PublishNotify instance

createPublishNotify

PublishNotify createPublishNotify(Identifier i1,
                                  Identifier i2,
                                  Document md)
Deprecated. 
Create a new PublishNotify instance that is used to publish metadata on a link between two Identifier instances.

Parameters:
i1 - the first Identifier of the link
i2 - the second Identifier of the link
md - the metadata that shall be published
Returns:
the new PublishNotify instance

createPublishNotify

PublishNotify createPublishNotify(Identifier i1,
                                  Collection<Document> mdlist)
Deprecated. 
Create a new PublishNotify instance that is used to publish a list of metadata instances.

Parameters:
i1 - the Identifier to which the given metadata is published to
mdlist - a list of metadata objects
Returns:
the new PublishNotify instance

createPublishNotify

PublishNotify createPublishNotify(Identifier i1,
                                  Identifier i2,
                                  Collection<Document> mdlist)
Deprecated. 
Create a new 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.

Parameters:
i1 - the first Identifier of the link
i2 - the second Identifier of the link
mdlist - a list of metadata objects
Returns:
the new PublishNotify instance

createSearchRequest

SearchRequest createSearchRequest()
Deprecated. 
Create a SearchRequest with default values. You need to set at least the start Identifier with SearchHolder.setStartIdentifier(Identifier) afterwards!

Returns:
the new SearchRequest instance

createSearchRequest

SearchRequest createSearchRequest(String matchLinks,
                                  Integer maxDepth,
                                  String terminalIdentifiers,
                                  Integer maxSize,
                                  String resultFilter,
                                  Identifier start)
Deprecated. 
Create a new SearchRequest in order to perform an IF-MAP search.

Parameters:
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
Returns:
the new SearchRequest instance

createSubscribeReq

SubscribeRequest createSubscribeReq()
Deprecated. 
Create an empty SubscribeRequest

Returns:
the new SubscribeRequest instance

createSubscribeReq

SubscribeRequest createSubscribeReq(SubscribeElement el)
Deprecated. 
Create a SubscribeRequest with one SubscribeElement.

Parameters:
el - the SubscribeElement that is added to the new SubscribeRequest. This can either be SubscribeUpdate or SubscribeDelete.
Returns:
the new SubscribeRequest

createSubscribeReq

SubscribeRequest createSubscribeReq(List<SubscribeElement> list)
Deprecated. 
Create a SubscribeRequest with a list of SubscribeElement instances.

Parameters:
list - the list of SubscribeElement instances that are added to the new SubscribeRequest. The SubscribeElement instances are either SubscribeUpdate or SubscribeDelete instances.
Returns:
the new SubscribeRequest

createSubscribeUpdate

SubscribeUpdate createSubscribeUpdate()
Deprecated. 
Create a SubscribeUpdate instance with default values. You need to add the start Identifier with SearchHolder.setStartIdentifier(Identifier) and the name with SubscribeElement.setName(String) afterwards!

Returns:
the new SubscribeUpdate instance

createSubscribeUpdate

SubscribeUpdate createSubscribeUpdate(String name,
                                      String matchLinks,
                                      Integer maxDepth,
                                      String terminalIdentifiers,
                                      Integer maxSize,
                                      String resultFilter,
                                      Identifier start)
Deprecated. 
Create a SubscribeUpdate instance with the given parameters.

Parameters:
name - the name of the subscription
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
Returns:
the new SubscribeUpdate instance

createSubscribeDelete

SubscribeDelete createSubscribeDelete()
Deprecated. 
Create a SubscribeDelete instance with default values. You need to set the name with SubscribeElement.setName(String) afterwards!

Returns:
the new SubscribeDelete instance

createSubscribeDelete

SubscribeDelete createSubscribeDelete(String name)
Deprecated. 
Create a new SubscribeDelete instance with the given name.

Parameters:
name - the name of the subscription that shall be deleted on the MAPS.
Returns:
the new SubscribeDelete instance


Copyright © 2012 Trust@FHH. All Rights Reserved.