org.apache.chemistry.opencmis.client.api

Interface SessionFactory

public interface SessionFactory

Entry point into the OpenCMIS Client API.

There might be different ways to get a SessionFactory instance. For example it could be retrieved via a J2EE JNDI lookup or an OSGi service lookup. Clients outside a container might use the SessionFactoryFinder class.

The entries of the parameter map are defined by SessionParameter class which is part of the commons package. Parameters specify connection settings (user name, authentication, connection URL, binding type, etc.).

The Session class which is constructed is either the session base class which is the default implementation or it can be derived from that implementing special behavior for the session.

Sample code:

 SessionFactory factory = ...
 
 Map<String, String> parameter = new HashMap<String, String>();
 
 parameter.put(SessionParameter.USER, "Otto");
 parameter.put(SessionParameter.PASSWORD, "****");
 
 parameter.put(SessionParameter.ATOMPUB_URL, "http://localhost/cmis/atom");
 parameter.put(SessionParameter.BINDING_TYPE, BindingType.ATOMPUB.value());
 parameter.put(SessionParameter.REPOSITORY_ID, "myRepository");
 ...
 Session session = factory.createSession(parameter);
 

See Also:

SessionFactoryFinder, SessionParameter, SessionParameterMap, Session

Method Summary

Modifier and Type	Method and Description
Session	createSession(Map<String,String> parameters) Creates a new session.
List<Repository>	getRepositories(Map<String,String> parameters) Returns all repositories that are available at the endpoint.

Method Detail

createSession

Session createSession(Map<String,String> parameters)

Creates a new session.

Parameters:

parameters - a map of name/value pairs with parameters for the session, see SessionParameter for parameters supported by OpenCMIS

Returns:

a Session connected to the CMIS repository, never null

See Also:

SessionParameter

getRepositories

List<Repository> getRepositories(Map<String,String> parameters)

Returns all repositories that are available at the endpoint.

Parameters:

parameters - a map of name/value pairs with parameters for the session, see SessionParameter for parameters supported by OpenCMIS, the parameter SessionParameter.REPOSITORY_ID should not be set

Returns:

a list of all available repositories, never null

See Also:

SessionParameter