gov.bnl.channelfinder.api (ChannelFinder Client API 3.0.3 API)

Interface Summary
Interface	Description
ChannelFinderClient	A Client object to query the channelfinder service for channels based on channel names and/or properties and tags associated with channels.
ChannelQueryListener

Class Summary
Class	Description
Channel	A Channel object represents channel finder channel. Each channel has a unique name and an owner and may have zero or more properties/tags associated with it.
Channel.Builder	Builder class to aid in a construction of a channel.
ChannelFinder
ChannelFinderClientComp
ChannelFinderClientImpl	A Client object to query the channelfinder service for channels based on channel names and/or properties and tags associated with channels.
ChannelFinderClientImpl.CFCBuilder	A Builder class to help create the client to the Channelfinder Service
ChannelQuery	An observable query to channel finder that maintains the cached result.
ChannelQuery.Builder
ChannelQuery.Result	Result of the query.
ChannelUtil
Property	A Property object represents a channel finder property which consists of the unique name, an owner and a value.
Property.Builder
RawLoggingFilter	A Raw HTML request/response logging filter.
Tag	A Tag object represents a channel finder tag which consists of the unique name and an owner.
Tag.Builder	Builder class to aid in a construction of a `Tag`.
XmlChannel	Channel object that can be represented as XML/JSON in payload data.
XmlProperty	Property object that can be represented as XML/JSON in payload data.
XmlTag	Tag object that can be represented as XML/JSON in payload data.

Exception Summary
Exception Description

ChannelFinderException
A Exception Type for various channelfinder exception conditions.

Exception Summary
Exception	Description
ChannelFinderException	A Exception Type for various channelfinder exception conditions.

Package gov.bnl.channelfinder.api Description

<div style="float: right; margin-top: -170px" id="contents"></div> <h1>Contents</h1> <h3>Creating a ChannelFinderClient</h3> <ol> <li><a href="#c1">Creating a simple client</a></li> </ol> <h3>Query Examples</h3> <ol> <li><a href="#q1">Query for channels based on name</a></li> <li><a href="#q2">Query for channels based on tags</a></li> <li><a href="#q3">Query for channels based on property</a></li> <li><a href="#q4">Query channels based on multiple criteria</a></li> </ol> 3 <h3>Set/Update/Delete Examples</h3> <ol> </ol> <h3 id="c1">Creating a simple client</h3> The ChannelFinderClient contains a builder to guide users through the process of creating the client. <pre> // Import from here import gov.bnl.channelfinder.api.ChannelFinderClient.CFCBuilder; // Create a client of the default service URL client = CFCBuilder.serviceURL().create(); // Create a client to the specified service with HTTP authentication enabled and with username myUsername and password myPasword authenticatedClient = CFCBuilder.serviceURL("http://my.server.location/ChannelFinder") .withHTTPAuthentication(true).username("myUsername").password("myPassword").create(); </pre> <h3 id="q1">Query for channels based on name</h3> <pre> // search for all channels in the channelfinder with name starting with "SR:C01". Collection<Channel> foundChannels = client.findByName("SR:C01*"); </pre> <h3 id="q2">Query for channels based on tags</h3> <pre> // search for all channels with the tag "shroffk-favorite-channel". Collection<Channel> foundChannels = client.findByTag("shroffk-favorite-channel"); </pre> <h3 id="q3">Query for channels based on property</h3> <pre> // search for all channel which have the property "device" with value = "bpm". Collection<Channel> foundChannels = client.findByProperty("device", "bpm"); // search for all channels which have the property "device with value "bpm" or "magnet" Collection<Channel> foundChannels = client.findByProperty("device", "bpm", "magnet"); </pre> <h3 id="q4">Query channels based on multiple criteria</h3> <pre> // search for channels with name starting with "SR:C01" AND with tag "shroffk-favorite-channel" // AND had property "device" with value "bpm" OR "magnet" Map<String, String> map = new Hashtable<String, String>(); map.put("~name", "SR:C01*"); map.put("~tag", "shroffk-favorite-channel"); map.put("device", "bpm, magnet"); Collection<Channel> foundChannels = client.find(map); // search for channels with name starting with "SR:C01" AND with tag "shroffk-favorite-channel" // AND had property "device" with value "bpm" OR "magnet" MultivaluedMapImpl multiValuedMap = new MultivaluedMapImpl(); multiValuedMap.put("~name", "SR:C01*"); multiValuedMap.put("~tag", "shroffk-favorite-channel"); multiValuedMap.add("device", "bpm"); multiValuedMap.add("device", "magnet"); Collection<Channel> foundChannels = client.find(multiValuedMap); </pre>