ChannelFinderClient (ChannelFinder Client API 3.0.3 API)

All Known Implementing Classes:

ChannelFinderClientComp, ChannelFinderClientImpl
```
public interface ChannelFinderClient
```
A Client object to query the channelfinder service for channels based on channel names and/or properties and tags associated with channels.

Author:

shroffk

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()` close
`void`	`delete(Collection<Channel.Builder> channels)` Deprecated.
`void`	`delete(Property.Builder property, Collection<String> channelNames)` Remove the property `property` from the set of channels `channelNames`
`void`	`delete(Property.Builder property, String channelName)` Remove property `property` from the channel with name `channelName`
`void`	`delete(Tag.Builder tag, Collection<String> channelNames)` Remove the tag `tag` from all the channels `channelNames`
`void`	`delete(Tag.Builder tag, String channelName)` Delete tag `tag` from the channel with the name `channelName`
`void`	`deleteChannel(String channelName)` Delete the channel identified by `channel`
`void`	`deleteProperty(String propertyName)` Completely Delete property with name = propertyName from all channels and the channelfinder service.
`void`	`deleteTag(String tagName)` Completely Delete {tag} with name = tagName from all channels and the channelfinder service.
`Collection<Channel>`	`find(Map<String,String> map)` Query for channels based on the multiple criteria specified in the map.
`Collection<Channel>`	`find(javax.ws.rs.core.MultivaluedMap<String,String> map)` uery for channels based on the multiple criteria specified in the map.
`Collection<Channel>`	`find(String query)` Space seperated search criterias, patterns may include * and ? wildcards channelNamePattern propertyName=valuePattern1,valuePattern2 Tags=tagNamePattern Each criteria is logically ANDed, \|\| seperated values are logically ORed Query for channels based on the Query string `query` example: find("SR* Cell=1,2 Tags=GolderOrbit,myTag) this will return all channels with names starting with SR AND have property Cell=1 OR 2 AND have tags goldenOrbit AND myTag. IMP: each criteria is logically AND'ed while multiple values for Properties are OR'ed.
`Collection<Channel>`	`findByName(String pattern)` Search for channels who's name match the pattern `pattern`. The pattern can contain wildcard char * or ?.
`Collection<Channel>`	`findByProperty(String property, String... pattern)` Search for channels with properties who's Value match the pattern `pattern`. The pattern can contain wildcard char * or ?.
`Collection<Channel>`	`findByTag(String pattern)` Search for channels with tags who's name match the pattern `pattern`. The pattern can contain wildcard char * or ?.
`Collection<Channel>`	`getAllChannels()`
`Collection<String>`	`getAllProperties()` Get a list of names of all the properties currently present on the channelfinder service.
`Collection<String>`	`getAllTags()` Get a list of names of all the tags currently present on the channelfinder service.
`Channel`	`getChannel(String channelName)` Returns a channel that exactly matches the channelName `channelName`.
`void`	`set(Channel.Builder channel)` Destructively set a single channel `channel`, if the channel already exists it will be replaced with the given channel.
`void`	`set(Collection<Channel.Builder> channels)`
`void`	`set(Property.Builder prop)` Destructively set a new property `property`.
`void`	`set(Property.Builder prop, Collection<String> channelNames)` Destructively set property `prop` and add it to the channels `channelNames` removing it from all other channels.
`void`	`set(Property.Builder prop, Map<String,String> channelPropertyMap)` Destructively set the property `prop` and add it to the channels specified in the `channelPropertyMap`, where the map key is the channel name and the associated value is the property value to be used for that channel.
`void`	`set(Property.Builder prop, String channelName)` Destructively set property `prop` and add it to the channel `channelName` and remove it from all others.
`void`	`set(Tag.Builder tag)` Destructively set a Tag `tag` with no associated channels to the database.
`void`	`set(Tag.Builder tag, Collection<String> channelNames)` Set tag `tag` on the set of channels {channels} and remove it from all others.
`void`	`set(Tag.Builder tag, String channelName)` Destructively set tag `tag` to channel `channelName` and remove the tag from all other channels.
`void`	`update(Channel.Builder channel)` Update existing channel with `channel`.
`void`	`update(Property.Builder property, Collection<String> channelNames)` Update the channels identified with `channelNames` with the property `property`
`void`	`update(Property.Builder property, Map<String,String> channelPropValueMap)` Update the property `property` on all channels specified in the channelPropValueMap, where the key in the map is the channel name and the value is the value for that property
`void`	`update(Property.Builder property, String channelName)` Update Property `property` by adding it to the channel `channelName`, without affecting the other channels.
`void`	`update(Tag.Builder tag, Collection<String> channelNames)` Update the Tag `tag` by adding it to the set of the channels with names `channelNames`, without affecting the other instances of this tag.
`void`	`update(Tag.Builder tag, String channelName)` Update Tag `tag` by adding it to Channel with name `channelName`, without affecting the other instances of this tag.

- Method Detail
  - getAllProperties
```
Collection<String> getAllProperties()
```
    Get a list of names of all the properties currently present on the channelfinder service.
    
    Returns:
    
    list of names of all existing Propertys.
  - getAllChannels
```
Collection<Channel> getAllChannels()
```
  - getAllTags
```
Collection<String> getAllTags()
```
    Get a list of names of all the tags currently present on the channelfinder service.
    
    Returns:
    
    a list of names of all the existing Tags.
  - getChannel
```
Channel getChannel(String channelName)
            throws ChannelFinderException
```
    Returns a channel that exactly matches the channelName channelName.
    
    Parameters:
    
    channelName - - name of the required channel.
    
    Returns:
    
    Channel with name channelName or null
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - set
```
void set(Channel.Builder channel)
  throws ChannelFinderException
```
    Destructively set a single channel channel, if the channel already exists it will be replaced with the given channel.
    
    Parameters:
    
    channel - the channel to be added
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - set
```
void set(Tag.Builder tag)
```
    Destructively set a Tag tag with no associated channels to the database.
    
    Parameters:
    
    tag - - the tag to be set.
  - set
```
void set(Tag.Builder tag,
         String channelName)
  throws ChannelFinderException
```
    Destructively set tag tag to channel channelName and remove the tag from all other channels.
    
    Parameters:
    
    tag - - the tag to be set.
    
    channelName - - the channel to which the tag should be set on.
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - set
```
void set(Tag.Builder tag,
         Collection<String> channelNames)
  throws ChannelFinderException
```
    Set tag tag on the set of channels {channels} and remove it from all others.
    
    Parameters:
    
    tag - - the tag to be set.
    
    channelNames - - the list of channels to which this tag will be added and removed from all others.
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - set
```
void set(Property.Builder prop)
  throws ChannelFinderException
```
    Destructively set a new property property.
    
    Parameters:
    
    prop - - the property to be set.
    
    Throws:
    
    ChannelFinderException
  - set
```
void set(Property.Builder prop,
         String channelName)
```
    Destructively set property prop and add it to the channel channelName and remove it from all others.
    
    Parameters:
    
    prop - - property to be set.
    
    channelName - - the channel to which this property must be added.
  - set
```
void set(Property.Builder prop,
         Collection<String> channelNames)
```
    Destructively set property prop and add it to the channels channelNames removing it from all other channels. By default all channels will contain the property with the same value specified in the prop.
    to individually set the value for each channel use channelPropertyMap.
    
    Parameters:
    
    prop - - the property to be set.
    
    channelNames - - the channels to which this property should be added and removed from all others.
  - set
```
void set(Property.Builder prop,
         Map<String,String> channelPropertyMap)
```
    Destructively set the property prop and add it to the channels specified in the channelPropertyMap, where the map key is the channel name and the associated value is the property value to be used for that channel.
    
    Parameters:
    
    prop - - the property to be set.
    
    channelPropertyMap - - map with channel names and property values
  - update
```
void update(Channel.Builder channel)
     throws ChannelFinderException
```
    Update existing channel with channel.
    
    Parameters:
    
    channel - - channel builder
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - update
```
void update(Tag.Builder tag,
            String channelName)
     throws ChannelFinderException
```
    Update Tag tag by adding it to Channel with name channelName, without affecting the other instances of this tag.
    
    Parameters:
    
    tag - the tag to be added
    
    channelName - Name of the channel to which the tag is to be added
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - update
```
void update(Tag.Builder tag,
            Collection<String> channelNames)
     throws ChannelFinderException
```
    Update the Tag tag by adding it to the set of the channels with names channelNames, without affecting the other instances of this tag.
    
    Parameters:
    
    tag - - the tag that needs to be updated.
    
    channelNames - - list of channels to which this tag should be added.
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - update
```
void update(Property.Builder property,
            String channelName)
     throws ChannelFinderException
```
    Update Property property by adding it to the channel channelName, without affecting the other channels.
    
    Parameters:
    
    property - - the property to be updated
    
    channelName - - the channel to which this property should be added or updated.
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - update
```
void update(Property.Builder property,
            Collection<String> channelNames)
     throws ChannelFinderException
```
    Update the channels identified with channelNames with the property property
    
    Parameters:
    
    property - - property builder
    
    channelNames - - list of channel names
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - update
```
void update(Property.Builder property,
            Map<String,String> channelPropValueMap)
     throws ChannelFinderException
```
    Update the property property on all channels specified in the channelPropValueMap, where the key in the map is the channel name and the value is the value for that property
    
    Parameters:
    
    property - - property builder
    
    channelPropValueMap - - property value map
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - findByName
```
Collection<Channel> findByName(String pattern)
                        throws ChannelFinderException
```
    Search for channels who's name match the pattern pattern.
    The pattern can contain wildcard char * or ?.
    
    Parameters:
    
    pattern - - the search pattern for the channel names
    
    Returns:
    
    A Collection of channels who's name match the pattern pattern
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - findByTag
```
Collection<Channel> findByTag(String pattern)
                       throws ChannelFinderException
```
    Search for channels with tags who's name match the pattern pattern.
    The pattern can contain wildcard char * or ?.
    
    Parameters:
    
    pattern - - the search pattern for the tag names
    
    Returns:
    
    A Collection of channels which contain tags who's name match the pattern pattern
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - findByProperty
```
Collection<Channel> findByProperty(String property,
                                   String... pattern)
                            throws ChannelFinderException
```
    Search for channels with properties who's Value match the pattern pattern.
    The pattern can contain wildcard char * or ?.
    
    Parameters:
    
    property - - the name of the property.
    
    pattern - - the seatch pattern for the property value.
    
    Returns:
    
    A collection of channels containing the property with name propertyName who's value matches the pattern pattern.
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - find
```
Collection<Channel> find(String query)
                  throws ChannelFinderException
```
    Space seperated search criterias, patterns may include * and ? wildcards channelNamePattern propertyName=valuePattern1,valuePattern2 Tags=tagNamePattern Each criteria is logically ANDed, || seperated values are logically ORed Query for channels based on the Query string query example: find("SR* Cell=1,2 Tags=GolderOrbit,myTag)
    this will return all channels with names starting with SR AND have property Cell=1 OR 2 AND have tags goldenOrbit AND myTag.
    IMP: each criteria is logically AND'ed while multiple values for Properties are OR'ed.
    
    Parameters:
    
    query - - channelfinder query
    
    Returns:
    
    Collection of channels which satisfy the search criteria.
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - find
```
Collection<Channel> find(Map<String,String> map)
                  throws ChannelFinderException
```
    Query for channels based on the multiple criteria specified in the map. Map.put("~name", "*")
    Map.put("~tag", "tag1")
    Map.put("Cell", "1,2,3") this will return all channels with name=any name AND tag=tag1 AND property Cell = 1 OR 2 OR 3.
    
    Parameters:
    
    map - - search map
    
    Returns:
    
    Collection of channels which satisfy the search map.
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - find
```
Collection<Channel> find(javax.ws.rs.core.MultivaluedMap<String,String> map)
                  throws ChannelFinderException
```
    uery for channels based on the multiple criteria specified in the map. Map.put("~name", "*")
    Map.put("~tag", "tag1")
    Map.put("Cell", "1")
    Map.put("Cell", "2")
    Map.put("Cell", "3")
    this will return all channels with name=any name AND tag=tag1 AND property Cell = 1 OR 2 OR 3.
    
    Parameters:
    
    map - - multivalued map of all search criteria
    
    Returns:
    
    Collection of channels which satisfy the search map.
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - deleteTag
```
void deleteTag(String tagName)
        throws ChannelFinderException
```
    Completely Delete {tag} with name = tagName from all channels and the channelfinder service.
    
    Parameters:
    
    tagName - - name of tag to be deleted.
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - deleteProperty
```
void deleteProperty(String propertyName)
             throws ChannelFinderException
```
    Completely Delete property with name = propertyName from all channels and the channelfinder service.
    
    Parameters:
    
    propertyName - - name of property to be deleted.
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - deleteChannel
```
void deleteChannel(String channelName)
            throws ChannelFinderException
```
    Delete the channel identified by channel
    
    Parameters:
    
    channelName - channel to be removed
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - delete
```
@Deprecated
void delete(Collection<Channel.Builder> channels)
                  throws ChannelFinderException
```
    Deprecated.
    
    Delete the set of channels identified by channels
    
    Parameters:
    
    channels - - list of channel builders
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - delete
```
void delete(Tag.Builder tag,
            String channelName)
     throws ChannelFinderException
```
    Delete tag tag from the channel with the name channelName
    
    Parameters:
    
    tag - - the tag to be deleted.
    
    channelName - - the channel from which to delete the tag tag
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - delete
```
void delete(Tag.Builder tag,
            Collection<String> channelNames)
     throws ChannelFinderException
```
    Remove the tag tag from all the channels channelNames
    
    Parameters:
    
    tag - - the tag to be deleted.
    
    channelNames - - the channels from which to delete the tag tag
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - delete
```
void delete(Property.Builder property,
            String channelName)
     throws ChannelFinderException
```
    Remove property property from the channel with name channelName
    
    Parameters:
    
    property - - the property to be deleted.
    
    channelName - - the channel from which to delete the property property
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - delete
```
void delete(Property.Builder property,
            Collection<String> channelNames)
     throws ChannelFinderException
```
    Remove the property property from the set of channels channelNames
    
    Parameters:
    
    property - - the property to be deleted.
    
    channelNames - - the channels from which to delete the property property
    
    Throws:
    
    ChannelFinderException - - channelfinder exception
  - close
```
void close()
```
    close
  - set
```
void set(Collection<Channel.Builder> channels)
```

Interface ChannelFinderClient

Method Summary

Method Detail

getAllProperties

getAllChannels

getAllTags

getChannel

set

set

set

set

set

set

set

set

update

update

update

update

update

update

findByName

findByTag

findByProperty

find

find

find

deleteTag

deleteProperty

deleteChannel

delete

delete

delete

delete

delete

close

set