com.softwareag.eda.estore.query.api

Class QuerySessionContext

java.lang.Object

com.softwareag.eda.estore.query.api.QuerySessionContext

public final class QuerySessionContext
extends java.lang.Object

This class provides a mechanism to specify and pass properties into the QuerySessionManager and QuerySessionFactory implementations. These properties are used as criteria for use when creating an active query session.

Constructor Summary

Constructors

Constructor and Description
QuerySessionContext() Construct a new session context for the Event Store session.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEventStorePassword()
java.lang.String	getEventStoreUser()
java.lang.String	getEventTypeStoreLocation()
java.lang.String	getOption(java.lang.String name) Return the value of the option speciifed by name.
java.util.List<java.lang.String>	getOptionKeys() Return a list of all the specified option names.
void	setEventStorePassword(java.lang.String eventStorePassword) Set the password associated with the user.
void	setEventStoreUser(java.lang.String eventStoreUser) Set the user under which all operations are performed.
void	setEventTypeStoreLocation(java.lang.String eventTypeStoreLocation) Set the location of the EDA Event Type Store.
void	setOption(java.lang.String name, java.lang.String value) Set the value for the session option specified by name.
void	validate() Some storage technologies don't require a user name or password.

Methods inherited from class java.lang.Object

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

Constructor Detail

QuerySessionContext

public QuerySessionContext()

Construct a new session context for the Event Store session.

Method Detail

getEventStoreUser

public java.lang.String getEventStoreUser()

Returns:

the value of the user or null if not set.

setEventStoreUser

public void setEventStoreUser(java.lang.String eventStoreUser)

Set the user under which all operations are performed. This is a required attribute. The Query API implementations will throw an exception if this attribute is not set.

Parameters:

eventStoreUser - The user to use to create the query session.

getEventStorePassword

public java.lang.String getEventStorePassword()

Returns:

the value of the user password or null if not set.

setEventStorePassword

public void setEventStorePassword(java.lang.String eventStorePassword)

Set the password associated with the user. This is a required attribute. The Query API implementations will throw an exception if this attribute is not set.

Parameters:

eventStorePassword - The password associated with the user.

getEventTypeStoreLocation

public java.lang.String getEventTypeStoreLocation()

Returns:

the value of the Event Type Store location or null if not set.

setEventTypeStoreLocation

public void setEventTypeStoreLocation(java.lang.String eventTypeStoreLocation)

Set the location of the EDA Event Type Store. This attribute may or may not be required depending on the implementation.

Parameters:

eventTypeStoreLocation - The location of the Event Type Store.

setOption

public void setOption(java.lang.String name,
                      java.lang.String value)

Set the value for the session option specified by name.

Parameters:

name - The name of the option to be set.

value - The options value.

getOption

public java.lang.String getOption(java.lang.String name)

Return the value of the option speciifed by name.

Parameters:

name - The name of the option to retrieve.

Returns:

The value for the specified option or null if it doesn't exist.

getOptionKeys

public java.util.List<java.lang.String> getOptionKeys()

Return a list of all the specified option names. Useful to iterate through the context.

Returns:

A list containing the names of all currently specified options.

validate

public void validate()

Some storage technologies don't require a user name or password. Elasticsearch is one of these technologies. When we support the "Shield" plugin we can set user name and password. Until then each query implementation will have to validate the context per their own requirements.