edu.byu.hbll.symwsclient

Class SymwsClientConfig

java.lang.Object

edu.byu.hbll.symwsclient.SymwsClientConfig

public final class SymwsClientConfig
extends Object

An immutable container of connection and authentication information for Symphony Web Services

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SymwsClientConfig.Builder A mutable builder to facilitate construction of SymwsClientConfig objects

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_HEADER_NAME
static String	SESSION_HEADER_NAME

Method Summary

Modifier and Type	Method and Description
void	finalize()
String	getClientId()
URI	getRootUri()
String	getSessionToken()
boolean	hasSession() Indicates whether this instance has a corresponding session TODO: Should this check whether the session is still alive?
SymwsClientConfig	newSession(String sessionToken) Returns a new SymwsClientConfig with the provided session.
SymwsClientConfig	newSession(String userId, String password) Uses the LoginUserClient to retrieve a new session, and returns a new SymwsClientConfig with that session.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_HEADER_NAME

public static final String CLIENT_HEADER_NAME

See Also:

Constant Field Values

SESSION_HEADER_NAME

public static final String SESSION_HEADER_NAME

See Also:

Constant Field Values

Method Detail

finalize

public void finalize()

Overrides:

finalize in class Object

newSession

public SymwsClientConfig newSession(String userId,
                                    String password)
                             throws SymwsClientException

Uses the LoginUserClient to retrieve a new session, and returns a new SymwsClientConfig with that session.

Parameters:

userId - the userId of the user to be authenticated

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

Returns:

a new, sessioned SymwsClientConfig instance

Throws:

SymwsClientException - if an error occurs while creating the new session

newSession

public SymwsClientConfig newSession(String sessionToken)

Returns a new SymwsClientConfig with the provided session.

Parameters:

sessionToken - the session token to attach to the new instance

Returns:

a new, sessioned SymwsClientConfig instance

hasSession

public boolean hasSession()

Indicates whether this instance has a corresponding session TODO: Should this check whether the session is still alive?

Returns:

true if this instance is sessioned, false otherwise

toString

public String toString()

Overrides:

toString in class Object

getRootUri

public URI getRootUri()

Returns:

the rootUri

getClientId

public String getClientId()

Returns:

the clientId

getSessionToken

public String getSessionToken()

Returns:

the sessionToken