com.sun.im.service
Class CollaborationSessionFactory

java.lang.Object
  extended bycom.sun.im.service.CollaborationSessionFactory

public class CollaborationSessionFactory
extends java.lang.Object

This class is a Factory class, which can be used to create CollborationSessions. It uses an implementation of CollaborationSessionProvider to create Collaborationsessions. The no argument constructor uses the java system property to identify the class name of the CollaborationSessionProvider implementation. Alternatively the other constructor takes the name of the class implementing the CollaborationSessionProvider interface. For a list of supported CollaborationSessionProvier implementations refer to your API provider's documentation. For a descripton of serviceURL refer to your API provider's documentation. Starting point used to create sessions.

See Also:
Default API provider's documentation

Field Summary
static java.lang.String CONFERENCE
          The Conference Service
static int MAJOR_VERSION
          major version number
static int MINOR_VERSION
          minor version number
static java.lang.String NEWS
          The News Service is an instant bulletin board service.
static java.lang.String NOTIFICATION
          The Notification Service allows you to send and receive acknowledged messages.
static java.lang.String PERSONALSTORE
          The Personal Store service allows you to access your personal information including your contact list or application configuration information.
static java.lang.String PRESENCE
          The presence Service lets you query other's availability and publish yours.
static java.lang.String systemProperty
          System property containing the name of the CollaborationSessionFactory to use.
 
Constructor Summary
CollaborationSessionFactory()
           
CollaborationSessionFactory(java.lang.String className)
           
 
Method Summary
 void close()
           
 CollaborationSessionProvider getCollaborationSessionProvider()
          gets an existing client session.
 CollaborationSession getSession(java.lang.String serviceUrl, java.lang.String loginName, java.lang.String password, CollaborationSessionListener listener)
          creates a collaboration session.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MAJOR_VERSION

public static final int MAJOR_VERSION
major version number

See Also:
Constant Field Values

MINOR_VERSION

public static final int MINOR_VERSION
minor version number

See Also:
Constant Field Values

CONFERENCE

public static final java.lang.String CONFERENCE
The Conference Service

See Also:
Constant Field Values

NEWS

public static final java.lang.String NEWS
The News Service is an instant bulletin board service. It allows news channels to be created, browsed, and managed.

See Also:
Constant Field Values

PRESENCE

public static final java.lang.String PRESENCE
The presence Service lets you query other's availability and publish yours.

See Also:
Constant Field Values

NOTIFICATION

public static final java.lang.String NOTIFICATION
The Notification Service allows you to send and receive acknowledged messages.

See Also:
Constant Field Values

PERSONALSTORE

public static final java.lang.String PERSONALSTORE
The Personal Store service allows you to access your personal information including your contact list or application configuration information.

See Also:
Constant Field Values

systemProperty

public static final java.lang.String systemProperty
System property containing the name of the CollaborationSessionFactory to use. This system property must be set in order to use a non-default implementation of CollaborationSessionFactory

See Also:
Constant Field Values
Constructor Detail

CollaborationSessionFactory

public CollaborationSessionFactory()
                            throws java.lang.Exception

CollaborationSessionFactory

public CollaborationSessionFactory(java.lang.String className)
                            throws java.lang.Exception
Method Detail

getSession

public CollaborationSession getSession(java.lang.String serviceUrl,
                                       java.lang.String loginName,
                                       java.lang.String password,
                                       CollaborationSessionListener listener)
                                throws CollaborationException
creates a collaboration session.

Parameters:
serviceUrl - URL for the authentication service (hostname and port).
loginName - login name
password - user password
listener - session listener to convey asynchronous errors and events.
Returns:
an authenticated collaboration services session.
Throws:
CollaborationException

getCollaborationSessionProvider

public CollaborationSessionProvider getCollaborationSessionProvider()
gets an existing client session. This method is used when the application creates many session objects and relies on the API to keep track of them.

Returns:
a collaboration services session.

close

public void close()