com.primus.ae.searchclient
Class SessionConfig

java.lang.Object
  com.primus.ae.searchclient.SessionConfig

All Implemented Interfaces:

java.io.Serializable

public class SessionConfig
extends java.lang.Object
implements java.io.Serializable

Configuration for a search session. Starts out with pre-defined option sets.

See Also:

OptionSets, Serialized Form

Constructor Summary

SessionConfig()

SessionConfig(java.lang.String envname)
Initializes a session config for the given site

SessionConfig(java.lang.String sitename, java.lang.String username)
Deprecated. as of 2007.0. sitename maps to environment name

SessionConfig(java.lang.String sitename, java.lang.String username, java.lang.String language, java.lang.String ipAddress, java.lang.String webBrowser, java.lang.String operatingSystem, java.lang.String emailAddress)
Deprecated. as of 2007.0. sitename maps to the search environment name

Method Summary

void	addOptionSet(java.lang.String optionSetName) Use this prior to session creation to specify which option sets should be cached locally for the session.
java.lang.String	getEnvname()
java.lang.String	getLanguage()
java.util.ArrayList	getOptionSetNames()
java.lang.String	getSitename() Deprecated. as of Search 2007.0
java.lang.String	getUsername() Deprecated. as of Search 2007.0
void	setEnvname(java.lang.String envname)
void	setLanguage(java.lang.String language)
void	setOptionSetNames(java.util.ArrayList optionSetNames)
void	setSitename(java.lang.String sitename) Deprecated. as of Search 2007.0
void	setUsername(java.lang.String username) Deprecated. as of Search 2007.0
java.lang.String	toXml()

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionConfig

public SessionConfig()

SessionConfig

public SessionConfig(java.lang.String envname)

Initializes a session config for the given site

Parameters:

envname - name of the environment to search, in this format:

envName[:[logicalPartitionName]:[service-specific-identifier]]

SessionConfig

public SessionConfig(java.lang.String sitename,
                     java.lang.String username)

Deprecated. as of 2007.0. sitename maps to environment name

Minimal constructor, uses "en" as the language, leaves other parameters empty.

Parameters:

sitename - Name of site, as configured in Management Console, e.g., "default"

username - Username for site login, e.g., "anonymous".

SessionConfig

public SessionConfig(java.lang.String sitename,
                     java.lang.String username,
                     java.lang.String language,
                     java.lang.String ipAddress,
                     java.lang.String webBrowser,
                     java.lang.String operatingSystem,
                     java.lang.String emailAddress)

Deprecated. as of 2007.0. sitename maps to the search environment name

Allows for full specification of the session. The parameters beyond those in the other constructor are used for logging purposes.

Parameters:

sitename - Name of site, as configured in Management Console, e.g., "default"

username - Username for site login, e.g., "anonymous"

language - E.g., "en"

ipAddress - User's IP address

webBrowser - User's web browser

operatingSystem - User's OS

emailAddress - User's email address

Method Detail

setSitename

public void setSitename(java.lang.String sitename)

Deprecated. as of Search 2007.0

no-op

Parameters:

sitename -

getSitename

public java.lang.String getSitename()

Deprecated. as of Search 2007.0

No-op, always returns an empty (non-null) string.

Returns:

empty string

setUsername

public void setUsername(java.lang.String username)

Deprecated. as of Search 2007.0

no-op

Parameters:

username -

getUsername

public java.lang.String getUsername()

Deprecated. as of Search 2007.0

No-op, always returns an empty (non-null) string.

Returns:

empty string

addOptionSet

public void addOptionSet(java.lang.String optionSetName)

Use this prior to session creation to specify which option sets should be cached locally for the session. The option sets will be retrieved from the server.

Parameters:

optionSetName - name of option set to add

getOptionSetNames

public java.util.ArrayList getOptionSetNames()

Returns:

Option set names that will be (or were) requested

setOptionSetNames

public void setOptionSetNames(java.util.ArrayList optionSetNames)

Parameters:

optionSetNames - list of option set names that should be obtained from the server

toXml

public java.lang.String toXml()

Returns:

XML representation of session configuration <SessionConfig><ipAddress>host</ipAddress>...</SessionConfig>

getEnvname

public java.lang.String getEnvname()

Returns:

name of search environment

setEnvname

public void setEnvname(java.lang.String envname)

Parameters:

envname - name of search environment to search

getLanguage

public java.lang.String getLanguage()

Returns:

language ID

setLanguage

public void setLanguage(java.lang.String language)

Parameters:

language - language ID, e.g., "en"