com.compoze.collab
Class SessionFactory

java.lang.Object

  |

  +--com.compoze.collab.SessionFactory

public class SessionFactory

extends java.lang.Object

The SessionFactory class is used to construct session based on the creation parameters specified by a client.

Method Summary

static ISession

createSession(java.util.Map properties) Creates an instance of ISession.

Methods inherited from class java.lang.Object

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

Method Detail

createSession

public static ISession createSession(java.util.Map properties)
                              throws CollaborationException

Creates an instance of ISession. The properties needed to create the session may be found in the documentation for this method plus the documentation for the provider specific session you are trying to open (references to provider specific session classes are in the See Also section. The session is not actually opened until its open method is called.

Parameters:

properties - the properties needed to instantiate the session (Properties include the common properties listed below plus any provider specific properties. The implementation backing the specified Map must be serializable if the session is to be serialized.)

• ISession.PROP_PROVIDER - required- the internal name of the provider
• ISession.PROP_SCHEMA - optional- the internal name of the desired schema support (must be one of the provider's supported schemas)
• ISession.PROP_LOCALE - optional- a user locale for the session (this Locale object is used when obtaining all internationalizable resources intended for the user. If this property is not specified then the value of Locale.getDefault() is used)
• ISession.PROP_PROGRAMMER_LOCALE - optional- a programmer locale for the session (this Locale object is used when obtaining all internationalizable resources intended for the programmer. If this property is not specified then the value of Locale.getDefault() is used)
• ISession.PROP_ADMIN_LOCALE - optional- an admin locale for the session (this Locale object is used when obtaining all internationalizable resources intended for the administrator. If this property is not specified then the value of Locale.getDefault() is used)
• ISession.PROP_AUTO_FETCH - optional- if "true" (the default) automatically fetch properties from the server that have not already been retrieved. If "false", throw an exception when a property is has not been retrieved (useful for development to determine if you are fully specifying all of the properties in your QueryProfile objects. If you are not doing this, the efficiency of your application will degrade because multiple queries will need to be made to the server for each item).
• ISession.PROP_LOG_LEVEL - optional- the log level for messages generated for the session (an instance of LogLevel. If not specified, then the value of CollaborationManager.getDefaultLogLevel() is used)

Throws:

CollaborationException - if validation of the specified session properties failed