gov.bnl.channelfinder.api

Class ChannelFinderClientImpl.CFCBuilder

java.lang.Object

gov.bnl.channelfinder.api.ChannelFinderClientImpl.CFCBuilder

Enclosing class:

ChannelFinderClientImpl

public static class ChannelFinderClientImpl.CFCBuilder
extends Object

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

Author:

shroffk

Method Summary

Methods

Modifier and Type	Method and Description
ChannelFinderClient	create() Will actually create a ChannelFinderClientImpl object using the configuration informoation in this builder.
ChannelFinderClientImpl.CFCBuilder	password(String password) Set the password to be used for the HTTP Authentication.
static ChannelFinderClientImpl.CFCBuilder	serviceURL() Creates a ChannelFinderClientImpl.CFCBuilder for a CF client to Default URL in the channelfinder.properties.
static ChannelFinderClientImpl.CFCBuilder	serviceURL(String uri) Creates a ChannelFinderClientImpl.CFCBuilder for a CF client to URI uri.
static ChannelFinderClientImpl.CFCBuilder	serviceURL(URI uri) Creates a ChannelFinderClientImpl.CFCBuilder for a CF client to URI uri.
ChannelFinderClientImpl.CFCBuilder	username(String username) Set the username to be used for HTTP Authentication.
ChannelFinderClientImpl.CFCBuilder	withClientConfig(com.sun.jersey.api.client.config.ClientConfig clientConfig) set the ClientConfig to be used while creating the channelfinder client connection.
ChannelFinderClientImpl.CFCBuilder	withExecutor(ExecutorService executor) Provide your own executor on which the queries are to be made.
ChannelFinderClientImpl.CFCBuilder	withHTTPAuthentication(boolean withHTTPAuthentication) Enable of Disable the HTTP authentication on the client connection.
ChannelFinderClientImpl.CFCBuilder	withTrustManager(TrustManager[] trustManager) Set the trustManager that should be used for authentication.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

serviceURL

public static ChannelFinderClientImpl.CFCBuilder serviceURL()

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

Returns:

ChannelFinderClientImpl.CFCBuilder

serviceURL

public static ChannelFinderClientImpl.CFCBuilder serviceURL(String uri)

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

Parameters:

uri -

Returns:

ChannelFinderClientImpl.CFCBuilder

serviceURL

public static ChannelFinderClientImpl.CFCBuilder serviceURL(URI uri)

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

Parameters:

uri -

Returns:

ChannelFinderClientImpl.CFCBuilder

withHTTPAuthentication

public ChannelFinderClientImpl.CFCBuilder withHTTPAuthentication(boolean withHTTPAuthentication)

Enable of Disable the HTTP authentication on the client connection.

Parameters:

withHTTPAuthentication -

Returns:

ChannelFinderClientImpl.CFCBuilder

username

public ChannelFinderClientImpl.CFCBuilder username(String username)

Set the username to be used for HTTP Authentication.

Parameters:

username -

Returns:

ChannelFinderClientImpl.CFCBuilder

password

public ChannelFinderClientImpl.CFCBuilder password(String password)

Set the password to be used for the HTTP Authentication.

Parameters:

password -

Returns:

ChannelFinderClientImpl.CFCBuilder

withClientConfig

public ChannelFinderClientImpl.CFCBuilder withClientConfig(com.sun.jersey.api.client.config.ClientConfig clientConfig)

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

Parameters:

clientConfig -

Returns:

ChannelFinderClientImpl.CFCBuilder

withTrustManager

public ChannelFinderClientImpl.CFCBuilder withTrustManager(TrustManager[] trustManager)

Set the trustManager that should be used for authentication.

Parameters:

trustManager -

Returns:

ChannelFinderClientImpl.CFCBuilder

withExecutor

public ChannelFinderClientImpl.CFCBuilder withExecutor(ExecutorService executor)

Provide your own executor on which the queries are to be made.
By default a single threaded executor is used.

Parameters:

executor -

Returns:

ChannelFinderClientImpl.CFCBuilder

create

public ChannelFinderClient create()
                           throws ChannelFinderException

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

Returns:

ChannelFinderClientImpl

Throws:

ChannelFinderException