A B C D E F G H O P Q R S T U V W X

A

addChannelQueryListener(ChannelQueryListener) - Method in class gov.bnl.channelfinder.api.ChannelQuery

Adds a new listener that is called every time the query is executed.

addXmlProperty(XmlProperty) - Method in class gov.bnl.channelfinder.api.XmlChannel

Adds an XmlProperty to the channel.

addXmlTag(XmlTag) - Method in class gov.bnl.channelfinder.api.XmlChannel

Adds an XmlTag to the collection.

B

build() - Method in class gov.bnl.channelfinder.api.Channel.Builder

build a Channel object using this builder.

build() - Method in class gov.bnl.channelfinder.api.ChannelQuery.Builder

Creates the new query.

build() - Method in class gov.bnl.channelfinder.api.Property.Builder

Build a Property object using this builder.

build() - Method in class gov.bnl.channelfinder.api.Tag.Builder

Build a Tag object using this builder

Builder() - Constructor for class gov.bnl.channelfinder.api.Channel.Builder

Builder() - Constructor for class gov.bnl.channelfinder.api.Property.Builder

Builder() - Constructor for class gov.bnl.channelfinder.api.Tag.Builder

buildSearchMap(String) - Static method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

C

Channel - Class in gov.bnl.channelfinder.api

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(Channel) - Static method in class gov.bnl.channelfinder.api.Channel.Builder

Create a channel builder initialized to a copy of the channel

channel(String) - Static method in class gov.bnl.channelfinder.api.Channel.Builder

Create a channel builder for a channel with the given name

Channel.Builder - Class in gov.bnl.channelfinder.api

Builder class to aid in a construction of a channel.

ChannelFinder - Class in gov.bnl.channelfinder.api

ChannelFinderClient - Interface in gov.bnl.channelfinder.api

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

ChannelFinderClientComp - Class in gov.bnl.channelfinder.api

ChannelFinderClientImpl - Class in gov.bnl.channelfinder.api

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

ChannelFinderClientImpl.CFCBuilder - Class in gov.bnl.channelfinder.api

A Builder class to help create the client to the Channelfinder Service

ChannelFinderException - Exception in gov.bnl.channelfinder.api

A Exception Type for various channelfinder exception conditions.

ChannelFinderException() - Constructor for exception gov.bnl.channelfinder.api.ChannelFinderException

ChannelFinderException(String) - Constructor for exception gov.bnl.channelfinder.api.ChannelFinderException

ChannelFinderException(UniformInterfaceException) - Constructor for exception gov.bnl.channelfinder.api.ChannelFinderException

ChannelFinderException(ClientResponse.Status, String) - Constructor for exception gov.bnl.channelfinder.api.ChannelFinderException

ChannelFinderException(ClientResponse.Status, Throwable, String) - Constructor for exception gov.bnl.channelfinder.api.ChannelFinderException

ChannelQuery - Class in gov.bnl.channelfinder.api

An observable query to channel finder that maintains the cached result.

ChannelQuery.Builder - Class in gov.bnl.channelfinder.api

ChannelQuery.Result - Class in gov.bnl.channelfinder.api

Result of the query.

ChannelQueryListener - Interface in gov.bnl.channelfinder.api

channels - Variable in class gov.bnl.channelfinder.api.ChannelQuery.Result

ChannelUtil - Class in gov.bnl.channelfinder.api

close() - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

close

close() - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

close() - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

close

create() - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl.CFCBuilder

Will actually create a ChannelFinderClientImpl object using the configuration informoation in this builder.

D

DEFAULT_CLIENT - Static variable in class gov.bnl.channelfinder.api.ChannelFinder

delete(Collection<Channel.Builder>) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Deprecated.

delete(Tag.Builder, String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Delete tag tag from the channel with the name channelName

delete(Tag.Builder, Collection<String>) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Remove the tag tag from all the channels channelNames

delete(Property.Builder, String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Remove property property from the channel with name channelName

delete(Property.Builder, Collection<String>) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Remove the property property from the set of channels channelNames

delete(Collection<Channel.Builder>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

delete(Tag.Builder, String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

delete(Property.Builder, String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

delete(Tag.Builder, Collection<String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

delete(Property.Builder, Collection<String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

delete(Collection<Channel.Builder>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Deprecated.

delete(Tag.Builder, String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Delete tag tag from the channel with the name channelName

delete(Tag.Builder, Collection<String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Remove the tag tag from all the channels channelNames

delete(Property.Builder, String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Remove property property from the channel with name channelName

delete(Property.Builder, Collection<String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Remove the property property from the set of channels channelNames

deleteChannel(String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Delete the channel identified by channel

deleteChannel(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

deleteChannel(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Delete the channel identified by channel

deleteProperty(String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Completely Delete property with name = propertyName from all channels and the channelfinder service.

deleteProperty(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

deleteProperty(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Completely Delete property with name = propertyName from all channels and the channelfinder service.

deleteTag(String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Completely Delete {tag} with name = tagName from all channels and the channelfinder service.

deleteTag(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

deleteTag(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Completely Delete {tag} with name = tagName from all channels and the channelfinder service.

E

equals(Object) - Method in class gov.bnl.channelfinder.api.Channel

equals(Object) - Method in class gov.bnl.channelfinder.api.ChannelQuery

equals(Object) - Method in class gov.bnl.channelfinder.api.Property

equals(Object) - Method in class gov.bnl.channelfinder.api.Tag

exception - Variable in class gov.bnl.channelfinder.api.ChannelQuery.Result

execute(ChannelQueryListener) - Method in class gov.bnl.channelfinder.api.ChannelQuery

Executes the query and calls the listener with the result.

F

filterbyElements(Collection<Channel>, Collection<String>, Collection<String>) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

Given a Collection of channels returns a new collection of channels containing only those channels which have all the tags in the tagNames

filterbyProperties(Collection<Channel>, Collection<String>) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

Given a Collection of channels returns a new collection of channels containing only those channels which have all the properties in the propNames

filterbyTags(Collection<Channel>, Collection<String>) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

Given a Collection of channels returns a new collection of channels containing only those channels which have all the tags in the tagNames

find(String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

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.

find(Map<String, String>) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Query for channels based on the multiple criteria specified in the map.

find(MultivaluedMap<String, String>) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

uery for channels based on the multiple criteria specified in the map.

find(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

find(Map<String, String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

find(MultivaluedMap<String, String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

find(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

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.

find(Map<String, String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Query for channels based on the multiple criteria specified in the map.

find(MultivaluedMap<String, String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

uery for channels based on the multiple criteria specified in the map.

findByName(String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Search for channels who's name match the pattern pattern.
The pattern can contain wildcard char * or ?.

findByName(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

findByName(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Search for channels who's name match the pattern pattern.
The pattern can contain wildcard char * or ?.

findByProperty(String, String...) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Search for channels with properties who's Value match the pattern pattern.
The pattern can contain wildcard char * or ?.

findByProperty(String, String...) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

findByProperty(String, String...) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Search for channels with properties who's Value match the pattern pattern.
The pattern can contain wildcard char * or ?.

findByTag(String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Search for channels with tags who's name match the pattern pattern.
The pattern can contain wildcard char * or ?.

findByTag(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

findByTag(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Search for channels with tags who's name match the pattern pattern.
The pattern can contain wildcard char * or ?.

G

getAllChannels() - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

getAllChannels() - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

getAllChannels() - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

getAllProperties() - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Get a list of names of all the properties currently present on the channelfinder service.

getAllProperties() - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

getAllProperties() - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Get a list of names of all the properties currently present on the channelfinder service.

getAllTagNames(Collection<Channel>) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

Return a union of tag names associated with channels

getAllTags() - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Get a list of names of all the tags currently present on the channelfinder service.

getAllTags() - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

getAllTags() - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Get a list of names of all the tags currently present on the channelfinder service.

getChannel(String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Returns a channel that exactly matches the channelName channelName.

getChannel(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

getChannel(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Returns a channel that exactly matches the channelName channelName.

getChannelNames(Collection<Channel>) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

Returns all the channel Names in the given Collection of channels

getChannels() - Method in class gov.bnl.channelfinder.api.XmlProperty

Get the list of channels associated with this property

getChannels() - Method in class gov.bnl.channelfinder.api.XmlTag

Getter for tag's XmlChannels.

getClient() - Static method in class gov.bnl.channelfinder.api.ChannelFinder

getDefaultQueryExecutor() - Static method in class gov.bnl.channelfinder.api.ChannelQuery

The executor on which the queries are executed.

getInstance() - Static method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

getName() - Method in class gov.bnl.channelfinder.api.Channel

Returns the Name of the channel.

getName() - Method in class gov.bnl.channelfinder.api.Property

returns the property name.

getName() - Method in class gov.bnl.channelfinder.api.Tag

returns the tag name.

getName() - Method in class gov.bnl.channelfinder.api.XmlChannel

Getter for channel name.

getName() - Method in class gov.bnl.channelfinder.api.XmlProperty

Getter for property name.

getName() - Method in class gov.bnl.channelfinder.api.XmlTag

Getter for tag name.

getOwner() - Method in class gov.bnl.channelfinder.api.Channel

Returns the owner of this channel.

getOwner() - Method in class gov.bnl.channelfinder.api.Property

returns the property owner id.

getOwner() - Method in class gov.bnl.channelfinder.api.Tag

returns the tag owner.

getOwner() - Method in class gov.bnl.channelfinder.api.XmlChannel

Getter for channel owner.

getOwner() - Method in class gov.bnl.channelfinder.api.XmlProperty

Getter for property owner.

getOwner() - Method in class gov.bnl.channelfinder.api.XmlTag

Getter for tag owner.

getProperties() - Method in class gov.bnl.channelfinder.api.Channel

Returns a list of all the Propertys associated with this channel.

getProperties() - Method in class gov.bnl.channelfinder.api.XmlChannel

getProperty(String) - Method in class gov.bnl.channelfinder.api.Channel

Returns the Property with the name = propertyName if present on this channel else null if no property with given name found.

getProperty(Channel, String) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

Deprecated.

getPropertyNames() - Method in class gov.bnl.channelfinder.api.Channel

Returns a Collection of names of all the properties associated with this channel.

getPropertyNames(Channel) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

Return a list of property names associated with this channel

getPropertyNames(Collection<Channel>) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

Return a union of property names associated with channels

getPropValues(Collection<Channel>, String) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

getQuery() - Method in class gov.bnl.channelfinder.api.ChannelQuery

The text of the query.

getResult() - Method in class gov.bnl.channelfinder.api.ChannelQuery

The result of the query, if present.

getStatus() - Method in exception gov.bnl.channelfinder.api.ChannelFinderException

Returns the associated HTTP status code which caused this exception.

getTag(String) - Method in class gov.bnl.channelfinder.api.Channel

Returns the tag with name = tagName is present on this channel else returns null

getTag(Channel, String) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

Deprecated.

getTagNames() - Method in class gov.bnl.channelfinder.api.Channel

Returns a collection of all the names of the tags present on this channel.

getTagNames(Channel) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

Return a list of tag names associated with this channel

getTags() - Method in class gov.bnl.channelfinder.api.Channel

Returns a list of Tags associated with this channel.

getTags() - Method in class gov.bnl.channelfinder.api.XmlChannel

getValue() - Method in class gov.bnl.channelfinder.api.Property

returns the property value.

getValue() - Method in class gov.bnl.channelfinder.api.XmlProperty

Getter for property value.

gov.bnl.channelfinder.api - package gov.bnl.channelfinder.api

{@literal

H

handle(ClientRequest) - Method in class gov.bnl.channelfinder.api.RawLoggingFilter

hashCode() - Method in class gov.bnl.channelfinder.api.Channel

hashCode() - Method in class gov.bnl.channelfinder.api.ChannelQuery

hashCode() - Method in class gov.bnl.channelfinder.api.Property

hashCode() - Method in class gov.bnl.channelfinder.api.Tag

O

on(Executor) - Method in class gov.bnl.channelfinder.api.ChannelQuery.Builder

Changes which executor should execute the query.

owner(String) - Method in class gov.bnl.channelfinder.api.Channel.Builder

Set owner for the channel to be created

owner(String) - Method in class gov.bnl.channelfinder.api.Property.Builder

Set the owner for the property to be built.

owner(String) - Method in class gov.bnl.channelfinder.api.Tag.Builder

Set the owner for the tag to be built.

P

password(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl.CFCBuilder

Set the password to be used for the HTTP Authentication.

Property - Class in gov.bnl.channelfinder.api

A Property object represents a channel finder property which consists of the unique name, an owner and a value.

property(String) - Static method in class gov.bnl.channelfinder.api.Property.Builder

Builder class to aid in a construction of a Property.

property(String, String) - Static method in class gov.bnl.channelfinder.api.Property.Builder

Returns a Property.Builder to create a property with given.

property(Property) - Static method in class gov.bnl.channelfinder.api.Property.Builder

Returns a Property.Builder to for a property which is a copy of property.

Property.Builder - Class in gov.bnl.channelfinder.api

Q

query(String) - Static method in class gov.bnl.channelfinder.api.ChannelQuery

A new query with the given search string.

queryExecuted(ChannelQuery.Result) - Method in interface gov.bnl.channelfinder.api.ChannelQueryListener

R

RawLoggingFilter - Class in gov.bnl.channelfinder.api

A Raw HTML request/response logging filter.

RawLoggingFilter() - Constructor for class gov.bnl.channelfinder.api.RawLoggingFilter

Create a logging filter logging the request and response to a default JDK logger, named as the fully qualified class name of this class.

RawLoggingFilter(Logger) - Constructor for class gov.bnl.channelfinder.api.RawLoggingFilter

Create a logging filter logging the request and response to a JDK logger.

RawLoggingFilter(PrintStream) - Constructor for class gov.bnl.channelfinder.api.RawLoggingFilter

Create a logging filter logging the request and response to print stream.

refresh() - Method in class gov.bnl.channelfinder.api.ChannelQuery

Triggers a new execution of the query, and calls all the listeners as a result.

removeChannelQueryListener(ChannelQueryListener) - Method in class gov.bnl.channelfinder.api.ChannelQuery

Removes a listener.

resetPreferences() - Static method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Deprecated.

result(Collection<Channel>, Exception) - Method in class gov.bnl.channelfinder.api.ChannelQuery.Builder

Pre-fills the cached result with the given channels and exception.

Result(Exception, Collection<Channel>) - Constructor for class gov.bnl.channelfinder.api.ChannelQuery.Result

S

serviceURL() - Static method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl.CFCBuilder

Creates a ChannelFinderClientImpl.CFCBuilder for a CF client to Default URL in the channelfinder.properties.

serviceURL(String) - Static method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl.CFCBuilder

Creates a ChannelFinderClientImpl.CFCBuilder for a CF client to URI uri.

serviceURL(URI) - Static method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl.CFCBuilder

Creates a ChannelFinderClientImpl.CFCBuilder for a CF client to URI uri.

set(Channel.Builder) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Destructively set a single channel channel, if the channel already exists it will be replaced with the given channel.

set(Tag.Builder) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Destructively set a Tag tag with no associated channels to the database.

set(Tag.Builder, String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Destructively set tag tag to channel channelName and remove the tag from all other channels.

set(Tag.Builder, Collection<String>) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Set tag tag on the set of channels {channels} and remove it from all others.

set(Property.Builder) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Destructively set a new property property.

set(Property.Builder, String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Destructively set property prop and add it to the channel channelName and remove it from all others.

set(Property.Builder, Collection<String>) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Destructively set property prop and add it to the channels channelNames removing it from all other channels.

set(Property.Builder, Map<String, String>) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

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.

set(Collection<Channel.Builder>) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

set(Channel.Builder) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

set(Collection<Channel.Builder>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

set(Tag.Builder) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

set(Property.Builder) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

set(Tag.Builder, String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

set(Property.Builder, String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

set(Tag.Builder, Collection<String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

set(Property.Builder, Collection<String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

set(Property.Builder, Map<String, String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

set(Channel.Builder) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Destructively set a single channel channel, if the channel already exists it will be replaced with the given channel.

set(Collection<Channel.Builder>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Destructively set a set of channels, if any channels already exists it is replaced.

set(Tag.Builder) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Destructively set a Tag tag with no associated channels to the database.

set(Tag.Builder, String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Destructively set tag tag to channel channelName and remove the tag from all other channels.

set(Tag.Builder, Collection<String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Set tag tag on the set of channels {channels} and remove it from all others.

set(Tag.Builder, Map<String, String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

set(Property.Builder) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Destructively set a new property property.

set(Property.Builder, String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Destructively set property prop and add it to the channel channelName and remove it from all others.

set(Property.Builder, Collection<String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Destructively set property prop and add it to the channels channelNames removing it from all other channels.

set(Property.Builder, Map<String, String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

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.

setChannels(List<XmlChannel>) - Method in class gov.bnl.channelfinder.api.XmlProperty

set the channels associated with this property

setChannels(List<XmlChannel>) - Method in class gov.bnl.channelfinder.api.XmlTag

Setter for tag's XmlChannels.

setClient(ChannelFinderClient) - Static method in class gov.bnl.channelfinder.api.ChannelFinder

setDefaultQueryExecutor(Executor) - Static method in class gov.bnl.channelfinder.api.ChannelQuery

Change the executor on which the queries are executed.

setName(String) - Method in class gov.bnl.channelfinder.api.XmlChannel

Setter for channel name.

setName(String) - Method in class gov.bnl.channelfinder.api.XmlProperty

Setter for property name.

setName(String) - Method in class gov.bnl.channelfinder.api.XmlTag

Setter for tag name.

setOwner(String) - Method in class gov.bnl.channelfinder.api.XmlChannel

Setter for channel owner.

setOwner(String) - Method in class gov.bnl.channelfinder.api.XmlProperty

Setter for property owner.

setOwner(String) - Method in class gov.bnl.channelfinder.api.XmlTag

Setter for tag owner.

setProperties(List<XmlProperty>) - Method in class gov.bnl.channelfinder.api.XmlChannel

setReader(ChannelFinderClient) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

setStatus(ClientResponse.Status) - Method in exception gov.bnl.channelfinder.api.ChannelFinderException

Set the associated HTTP status code which caused this exception.

setTags(List<XmlTag>) - Method in class gov.bnl.channelfinder.api.XmlChannel

setValue(String) - Method in class gov.bnl.channelfinder.api.XmlProperty

Setter for property value.

setWriter(ChannelFinderClient) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

T

Tag - Class in gov.bnl.channelfinder.api

A Tag object represents a channel finder tag which consists of the unique name and an owner.

tag(Tag) - Static method in class gov.bnl.channelfinder.api.Tag.Builder

Returns a Tag.Builder to build a Tag which is a copy of the given tag.

tag(String) - Static method in class gov.bnl.channelfinder.api.Tag.Builder

Returns a tag Tag.Builder to build a Tag with the name name

tag(String, String) - Static method in class gov.bnl.channelfinder.api.Tag.Builder

Returns a tag Tag.Builder to build a Tag with the name name and owner owner

Tag.Builder - Class in gov.bnl.channelfinder.api

Builder class to aid in a construction of a Tag.

toChannels(Collection<Channel.Builder>) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

Returns a list of Channel built from the list of Channel.Builders

toCollectionXmlChannels(Collection<Channel.Builder>) - Static method in class gov.bnl.channelfinder.api.ChannelUtil

Returns a list of Channel built from the list of Channel.Builders

toLog(XmlChannel) - Static method in class gov.bnl.channelfinder.api.XmlChannel

Creates a compact string representation for the log.

toLog(XmlProperty) - Static method in class gov.bnl.channelfinder.api.XmlProperty

Creates a compact string representation for the log.

toLog(XmlTag) - Static method in class gov.bnl.channelfinder.api.XmlTag

Creates a compact string representation for the log.

toString() - Method in class gov.bnl.channelfinder.api.Channel

toString() - Method in class gov.bnl.channelfinder.api.ChannelQuery

toXml() - Method in class gov.bnl.channelfinder.api.Channel.Builder

build a XmlChannel object using this builder.

toXml() - Method in class gov.bnl.channelfinder.api.Property.Builder

Build a XmlProperty object using this builder.

toXml() - Method in class gov.bnl.channelfinder.api.Tag.Builder

Build a XmlTag object using this builder

U

update(Channel.Builder) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Update existing channel with channel.

update(Tag.Builder, String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Update Tag tag by adding it to Channel with name channelName, without affecting the other instances of this tag.

update(Tag.Builder, Collection<String>) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Update the Tag tag by adding it to the set of the channels with names channelNames, without affecting the other instances of this tag.

update(Property.Builder, String) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Update Property property by adding it to the channel channelName, without affecting the other channels.

update(Property.Builder, Collection<String>) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

Update the channels identified with channelNames with the property property

update(Property.Builder, Map<String, String>) - Method in interface gov.bnl.channelfinder.api.ChannelFinderClient

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

update(Channel.Builder) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

update(Tag.Builder, String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

update(Property.Builder, String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

update(Tag.Builder, Collection<String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

update(Property.Builder, Collection<String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

update(Property.Builder, Map<String, String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientComp

update(Channel.Builder) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Update existing channel with channel.

update(Tag.Builder, String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Update Tag tag by adding it to Channel with name channelName, without affecting the other instances of this tag.

update(Tag.Builder, Collection<String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Update the Tag tag by adding it to the set of the channels with names channelNames, without affecting the other instances of this tag.

update(Property.Builder, String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

Update Property property by adding it to the channel channelName, without affecting the other channels.

update(Property.Builder, Collection<String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

update(Property.Builder, Map<String, String>) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl

username(String) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl.CFCBuilder

Set the username to be used for HTTP Authentication.

using(ChannelFinderClient) - Method in class gov.bnl.channelfinder.api.ChannelQuery.Builder

Changes which client should be used to execute the query.

V

value(String) - Method in class gov.bnl.channelfinder.api.Property.Builder

Set the value for the property to be built.

W

with(Tag.Builder) - Method in class gov.bnl.channelfinder.api.Channel.Builder

Add tag to the channel to be created

with(Property.Builder) - Method in class gov.bnl.channelfinder.api.Channel.Builder

Add property to the channel to be created

withClientConfig(ClientConfig) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl.CFCBuilder

set the ClientConfig to be used while creating the channelfinder client connection.

withExecutor(ExecutorService) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl.CFCBuilder

Provide your own executor on which the queries are to be made.

withHTTPAuthentication(boolean) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl.CFCBuilder

Enable of Disable the HTTP authentication on the client connection.

withProperties(Collection<Property.Builder>) - Method in class gov.bnl.channelfinder.api.Channel.Builder

Add the Collection of properties to the channel to be created

withTags(Collection<Tag.Builder>) - Method in class gov.bnl.channelfinder.api.Channel.Builder

Add the Collection of tags to the channel to be created

withTrustManager(TrustManager[]) - Method in class gov.bnl.channelfinder.api.ChannelFinderClientImpl.CFCBuilder

Set the trustManager that should be used for authentication.

X

XmlChannel - Class in gov.bnl.channelfinder.api

Channel object that can be represented as XML/JSON in payload data.

XmlChannel() - Constructor for class gov.bnl.channelfinder.api.XmlChannel

Creates a new instance of XmlChannel

XmlChannel(String) - Constructor for class gov.bnl.channelfinder.api.XmlChannel

Creates a new instance of XmlChannel.

XmlChannel(String, String) - Constructor for class gov.bnl.channelfinder.api.XmlChannel

Creates a new instance of XmlChannel.

XmlChannel(String, String, List<XmlProperty>, List<XmlTag>) - Constructor for class gov.bnl.channelfinder.api.XmlChannel

XmlProperty - Class in gov.bnl.channelfinder.api

Property object that can be represented as XML/JSON in payload data.

XmlProperty() - Constructor for class gov.bnl.channelfinder.api.XmlProperty

Creates a new instance of XmlProperty.

XmlProperty(String, String) - Constructor for class gov.bnl.channelfinder.api.XmlProperty

Creates a new instance of XmlProperty.

XmlProperty(String, String, String) - Constructor for class gov.bnl.channelfinder.api.XmlProperty

Creates a new instance of XmlProperty.

XmlTag - Class in gov.bnl.channelfinder.api

Tag object that can be represented as XML/JSON in payload data.

XmlTag() - Constructor for class gov.bnl.channelfinder.api.XmlTag

Creates a new instance of XmlTag.

XmlTag(String) - Constructor for class gov.bnl.channelfinder.api.XmlTag

Creates a new instance of XmlTag.

XmlTag(String, String) - Constructor for class gov.bnl.channelfinder.api.XmlTag

Creates a new instance of XmlTag.

A B C D E F G H O P Q R S T U V W X