edu.byu.hbll.symwsclient

Class SymwsClientConfig.Builder

java.lang.Object

edu.byu.hbll.symwsclient.SymwsClientConfig.Builder

Enclosing class:

SymwsClientConfig

public static class SymwsClientConfig.Builder
extends Object

A mutable builder to facilitate construction of SymwsClientConfig objects

Constructor Summary

Constructors

Constructor and Description
Builder(String host, String clientId) Create a new Builder instance with the minimum required data.

Method Summary

Modifier and Type	Method and Description
SymwsClientConfig	build() Builds a new SymwsClientConfig using this Builder instance as a template.
SymwsClientConfig.Builder	path(String path) Overrides the default service path ("/") with the provided path.
SymwsClientConfig.Builder	port(Integer port) Overrides the default port (80) with the provided port number.
SymwsClientConfig.Builder	protocol(String protocol) Overrides the default protocol ("http") with the provided protocol.
SymwsClientConfig.Builder	session(String sessionToken) Provides a sessionToken to use when building the final SymwsClientConfig.
SymwsClientConfig.Builder	session(String userId, String password) Provides a userId and password to use to retrieve a sessionToken when building the final SymwsClientConfig.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String host,
               String clientId)
        throws NullPointerException,
               IllegalArgumentException

Create a new Builder instance with the minimum required data.

Parameters:

host - the hostname or IP address of the server providing Symphony Web Services

clientId - the Symphony Web Services client ID to use

Throws:

NullPointerException - if either the host or clientId are null

IllegalArgumentException - if either the host or clientId are empty

Method Detail

protocol

public SymwsClientConfig.Builder protocol(String protocol)

Overrides the default protocol ("http") with the provided protocol.

Parameters:

protocol - the protocol to use with the service URI. If null, the default value will be restored.

Returns:

the modified Builder instance

port

public SymwsClientConfig.Builder port(Integer port)

Overrides the default port (80) with the provided port number.

Parameters:

port - the port to use with the service URI. If null, the default value will be restored.

Returns:

the modified Builder instance

path

public SymwsClientConfig.Builder path(String path)

Overrides the default service path ("/") with the provided path. Note that this should be the path to the Symphony Web Service application root, NOT the path to a specific service endpoint.

Parameters:

path - the path to use with the service URI. If null, the default value will be restored.

Returns:

the modified Builder instance

session

public SymwsClientConfig.Builder session(String userId,
                                         String password)

Provides a userId and password to use to retrieve a sessionToken when building the final SymwsClientConfig.

Note that if an error occurs while retrieving a sessionToken during SymwsClientConfig construction, no exception will be thrown. Rather, the resulting instance will simply have a null sessionToken. Use the SymwsClientConfig's hasSession() method after construction to verify the existence of a sessionToken.

Parameters:

userId - the userId of the user to be authenticated. If null, no session info will be used with the final SymwsClientConfig.

password - the PIN/password of the user to be authenticated

Returns:

the modified Builder instance

session

public SymwsClientConfig.Builder session(String sessionToken)

Provides a sessionToken to use when building the final SymwsClientConfig.

Parameters:

sessionToken - the session token to use. If null, no session info will be used with the final SymwsClientConfig.

Returns:

the modified Builder Instance

build

public SymwsClientConfig build()

Builds a new SymwsClientConfig using this Builder instance as a template.

Returns:

the newly created (immutable) SymwsClientConfig