SessionParameter (Apache Chemistry OpenCMIS 0.9.0)

java.lang.Object
- org.apache.chemistry.opencmis.commons.SessionParameter

public final class SessionParameter
extends Object

Session parameter constants.

Constant	Description	Binding	Value	Required	Default
General settings
`BINDING_TYPE`	Defines the binding to use for the session	all	"atompub", "webservices", "browser", "local", "custom"	yes	-
`BINDING_SPI_CLASS`	Binding implementation class	all	class name	Custom binding: yes all other binding: no	depends on `BINDING_TYPE`
`REPOSITORY_ID`	Repository ID	all	repository id	SessionFactory.createSession(): yes SessionFactory.getRepositories(): no	-
`LOCALE_ISO639_LANGUAGE`	Language code sent to server	all	ISO 639 code	no	-
`LOCALE_ISO3166_COUNTRY`	Country code sent to server if language code is set	all	ISO 3166 code	no	-
`OBJECT_FACTORY_CLASS`	Object factory implementation class	all	class name	no	org.apache.chemistry.opencmis.client.runtime.repository.ObjectFactoryImpl
Authentication settings
`USER`	User name (used by the standard authentication provider)	all	user name	depends on the server	-
`PASSWORD`	Password (used by the standard authentication provider)	all	password	depends on the server	-
`AUTHENTICATION_PROVIDER_CLASS`	Authentication Provider class	AtomPub, Web Services, Browser	class name	no	org.apache.chemistry.opencmis.client.bindings.spi. StandardAuthenticationProvider
`AUTH_HTTP_BASIC`	Switch to turn HTTP basic authentication on or off	AtomPub, Web Services, Browser	"true", "false"	no	depends on `BINDING_TYPE`
`AUTH_SOAP_USERNAMETOKEN`	Switch to turn UsernameTokens on or off	Web Services	"true", "false"	no	true
HTTP and network settings
`HTTP_INVOKER_CLASS`	HTTP invoker class	AtomPub, Web Services, Browser	class name	no	org.apache.chemistry.opencmis.client.bindings.spi.http.DefaultHttpInvoker
`COMPRESSION`	Switch to turn HTTP response compression on or off	AtomPub, Web Services, Browser	"true", "false"	no	false
`CLIENT_COMPRESSION`	Switch to turn HTTP request compression on or off	AtomPub, Web Services, Browser	"true", "false"	no	false
`COOKIES`	Switch to turn cookie support on or off	AtomPub, Web Services, Browser	"true", "false"	no	false
`HEADER`	HTTP header	AtomPub, Web Services, Browser	header header	no	-
`PROXY_USER`	Proxy user (used by the standard authentication provider)	AtomPub, Web Services, Browser	user name	no	-
`PROXY_PASSWORD`	Proxy password (used by the standard authentication provider)	AtomPub, Web Services, Browser	password	no	-
`CONNECT_TIMEOUT`	HTTP connect timeout	AtomPub, Web Services, Browser	time in milliseconds	no	JVM default
`READ_TIMEOUT`	HTTP read timeout	AtomPub, Web Services, Browser	time in milliseconds	no	JVM default
Cache settings
`CACHE_CLASS`	Cache implementation class	all	class name	no	org.apache.chemistry.opencmis.client.runtime.cache.CacheImpl
`CACHE_SIZE_OBJECTS`	Object cache size	all	number of object entries	no	1000
`CACHE_TTL_OBJECTS`	Object cache time-to-live	all	time in milliseconds	no	7200000 (2 hours)
`CACHE_SIZE_PATHTOID`	Path-to-id cache size	all	number of path to object link entries	no	1000
`CACHE_PATH_OMIT`	Turn off path-to-id cache	all	"true", "false"	no	false
`CACHE_SIZE_REPOSITORIES`	Repository info cache size	all	number of repository info entries	no	10
`CACHE_SIZE_TYPES`	Type definition cache size	all	number of type definition entries	no	100
`CACHE_SIZE_LINKS`	AtomPub link cache size	AtomPub	number of link entries	no	400
AtomPub Binding settings
`ATOMPUB_URL`	AtomPub service document URL	AtomPub	URL	yes	-
Web Services Binding settings
`WEBSERVICES_REPOSITORY_SERVICE`	Repository Service WSDL URL	Web Services	WSDL URL	either `WEBSERVICES_REPOSITORY_SERVICE` or `WEBSERVICES_REPOSITORY_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_REPOSITORY_SERVICE_ENDPOINT`	Repository Service endpoint URL	Web Services	Endpoint URL	either `WEBSERVICES_REPOSITORY_SERVICE` or `WEBSERVICES_REPOSITORY_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_NAVIGATION_SERVICE`	Navigation Service WSDL URL	Web Services	WSDL URL	either `WEBSERVICES_NAVIGATION_SERVICE` or `WEBSERVICES_NAVIGATION_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_NAVIGATION_SERVICE_ENDPOINT`	Navigation Service endpoint URL	Web Services	Endpoint URL	either `WEBSERVICES_NAVIGATION_SERVICE` or `WEBSERVICES_NAVIGATION_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_OBJECT_SERVICE`	Object Service WSDL URL	Web Services	WSDL URL	either `WEBSERVICES_OBJECT_SERVICE` or `WEBSERVICES_OBJECT_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_OBJECT_SERVICE_ENDPOINT`	Object Service endpoint URL	Web Services	Endpoint URL	either `WEBSERVICES_OBJECT_SERVICE` or `WEBSERVICES_OBJECT_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_VERSIONING_SERVICE`	Versioning Service WSDL URL	Web Services	WSDL URL	either `WEBSERVICES_VERSIONING_SERVICE` or `WEBSERVICES_VERSIONING_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_VERSIONING_SERVICE_ENDPOINT`	Versioning Service endpoint URL	Web Services	Endpoint URL	either `WEBSERVICES_VERSIONING_SERVICE` or `WEBSERVICES_VERSIONING_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_DISCOVERY_SERVICE`	Discovery Service WSDL URL	Web Services	WSDL URL	either `WEBSERVICES_DISCOVERY_SERVICE` or `WEBSERVICES_DISCOVERY_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_DISCOVERY_SERVICE_ENDPOINT`	Discovery Service endpoint URL	Web Services	Endpoint URL	either `WEBSERVICES_DISCOVERY_SERVICE` or `WEBSERVICES_DISCOVERY_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_RELATIONSHIP_SERVICE`	Relationship Service WSDL URL	Web Services	WSDL URL	either `WEBSERVICES_RELATIONSHIP_SERVICE` or `WEBSERVICES_RELATIONSHIP_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_RELATIONSHIP_SERVICE_ENDPOINT`	Relationship Service endpoint URL	Web Services	Endpoint URL	either `WEBSERVICES_DISCOVERY_SERVICE` or `WEBSERVICES_RELATIONSHIP_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_MULTIFILING_SERVICE`	Multifiling Service WSDL URL	Web Services	WSDL URL	either `WEBSERVICES_MULTIFILING_SERVICE` or `WEBSERVICES_MULTIFILING_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_MULTIFILING_SERVICE_ENDPOINT`	Multifiling Service endpoint URL	Web Services	Endpoint URL	either `WEBSERVICES_MULTIFILING_SERVICE` or `WEBSERVICES_MULTIFILING_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_POLICY_SERVICE`	Policy Service WSDL URL	Web Services	WSDL URL	either `WEBSERVICES_POLICY_SERVICE` or `WEBSERVICES_POLICY_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_POLICY_SERVICE_ENDPOINT`	Policy Service endpoint URL	Web Services	Endpoint URL	either `WEBSERVICES_POLICY_SERVICE` or `WEBSERVICES_POLICY_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_ACL_SERVICE`	ACL Service WSDL URL	Web Services	WSDL URL	either `WEBSERVICES_ACL_SERVICE` or `WEBSERVICES_ACL_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_ACL_SERVICE_ENDPOINT`	ACL Service endpoint URL	Web Services	Endpoint URL	either `WEBSERVICES_ACL_SERVICE` or `WEBSERVICES_ACL_SERVICE_ENDPOINT` must be set	-
`WEBSERVICES_MEMORY_THRESHOLD`	Documents smaller than the threshold are kept in main memory, larger documents are written to a temporary file	Web Services	size in bytes	no	4194304 (4MB)
Browser Binding
`BROWSER_URL`	Browser binding service document URL	Browser	URL	yes	-
`BROWSER_SUCCINCT`	Defines if properties should be sent in the succinct format	Browser	"true", "false"	no	"true"
Local Binding
`LOCAL_FACTORY`	Class name of the local service factory (if client and server reside in the same JVM)	Local	class name	yes	-

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATOMPUB_URL` URL of the AtomPub service document.
`static String`	`AUTH_HTTP_BASIC` Toggle for HTTP basic authentication.
`static String`	`AUTH_SOAP_USERNAMETOKEN` Toggle for WS-Security UsernameToken authentication.
`static String`	`AUTHENTICATION_PROVIDER_CLASS` Class name of the authentication provider.
`static String`	`BINDING_SPI_CLASS` Class name of the binding class.
`static String`	`BINDING_TYPE` Predefined binding types (see `BindingType`)
`static String`	`BROWSER_SUCCINCT`
`static String`	`BROWSER_URL` URL of the Browser Binding entry point.
`static String`	`CACHE_CLASS`
`static String`	`CACHE_PATH_OMIT`
`static String`	`CACHE_SIZE_LINKS`
`static String`	`CACHE_SIZE_OBJECTS`
`static String`	`CACHE_SIZE_PATHTOID`
`static String`	`CACHE_SIZE_REPOSITORIES`
`static String`	`CACHE_SIZE_TYPES`
`static String`	`CACHE_TTL_OBJECTS`
`static String`	`CACHE_TTL_PATHTOID`
`static String`	`CLIENT_COMPRESSION`
`static String`	`COMPRESSION`
`static String`	`CONNECT_TIMEOUT`
`static String`	`COOKIES`
`static String`	`HEADER`
`static String`	`HTTP_INVOKER_CLASS`
`static String`	`LOCAL_FACTORY` Factory class name for the local binding.
`static String`	`LOCALE_ISO3166_COUNTRY`
`static String`	`LOCALE_ISO639_LANGUAGE`
`static String`	`LOCALE_VARIANT`
`static String`	`OBJECT_FACTORY_CLASS`
`static String`	`PASSWORD`
`static String`	`PROXY_PASSWORD`
`static String`	`PROXY_USER`
`static String`	`READ_TIMEOUT`
`static String`	`REPOSITORY_ID`
`static String`	`USER`
`static String`	`WEBSERVICES_ACL_SERVICE`
`static String`	`WEBSERVICES_ACL_SERVICE_ENDPOINT`
`static String`	`WEBSERVICES_DISCOVERY_SERVICE`
`static String`	`WEBSERVICES_DISCOVERY_SERVICE_ENDPOINT`
`static String`	`WEBSERVICES_JAXWS_IMPL`
`static String`	`WEBSERVICES_MEMORY_THRESHOLD`
`static String`	`WEBSERVICES_MULTIFILING_SERVICE`
`static String`	`WEBSERVICES_MULTIFILING_SERVICE_ENDPOINT`
`static String`	`WEBSERVICES_NAVIGATION_SERVICE`
`static String`	`WEBSERVICES_NAVIGATION_SERVICE_ENDPOINT`
`static String`	`WEBSERVICES_OBJECT_SERVICE`
`static String`	`WEBSERVICES_OBJECT_SERVICE_ENDPOINT`
`static String`	`WEBSERVICES_POLICY_SERVICE`
`static String`	`WEBSERVICES_POLICY_SERVICE_ENDPOINT`
`static String`	`WEBSERVICES_PORT_PROVIDER_CLASS`
`static String`	`WEBSERVICES_RELATIONSHIP_SERVICE`
`static String`	`WEBSERVICES_RELATIONSHIP_SERVICE_ENDPOINT`
`static String`	`WEBSERVICES_REPOSITORY_SERVICE` WSDL URLs for Web Services.
`static String`	`WEBSERVICES_REPOSITORY_SERVICE_ENDPOINT` Endpoint URLs for Web Services.
`static String`	`WEBSERVICES_VERSIONING_SERVICE`
`static String`	`WEBSERVICES_VERSIONING_SERVICE_ENDPOINT`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - USER
```
public static final String USER
```
    See Also:
    Constant Field Values
  - PASSWORD
```
public static final String PASSWORD
```
    See Also:
    Constant Field Values
  - BINDING_TYPE
```
public static final String BINDING_TYPE
```
    Predefined binding types (see BindingType)
    
    See Also:
    Constant Field Values
  - BINDING_SPI_CLASS
```
public static final String BINDING_SPI_CLASS
```
    Class name of the binding class.
    
    See Also:
    Constant Field Values
  - ATOMPUB_URL
```
public static final String ATOMPUB_URL
```
    URL of the AtomPub service document.
    
    See Also:
    Constant Field Values
  - WEBSERVICES_REPOSITORY_SERVICE
```
public static final String WEBSERVICES_REPOSITORY_SERVICE
```
    WSDL URLs for Web Services.
    
    See Also:
    Constant Field Values
  - WEBSERVICES_NAVIGATION_SERVICE
```
public static final String WEBSERVICES_NAVIGATION_SERVICE
```
    See Also:
    Constant Field Values
  - WEBSERVICES_OBJECT_SERVICE
```
public static final String WEBSERVICES_OBJECT_SERVICE
```
    See Also:
    Constant Field Values
  - WEBSERVICES_VERSIONING_SERVICE
```
public static final String WEBSERVICES_VERSIONING_SERVICE
```
    See Also:
    Constant Field Values
  - WEBSERVICES_DISCOVERY_SERVICE
```
public static final String WEBSERVICES_DISCOVERY_SERVICE
```
    See Also:
    Constant Field Values
  - WEBSERVICES_RELATIONSHIP_SERVICE
```
public static final String WEBSERVICES_RELATIONSHIP_SERVICE
```
    See Also:
    Constant Field Values
  - WEBSERVICES_MULTIFILING_SERVICE
```
public static final String WEBSERVICES_MULTIFILING_SERVICE
```
    See Also:
    Constant Field Values
  - WEBSERVICES_POLICY_SERVICE
```
public static final String WEBSERVICES_POLICY_SERVICE
```
    See Also:
    Constant Field Values
  - WEBSERVICES_ACL_SERVICE
```
public static final String WEBSERVICES_ACL_SERVICE
```
    See Also:
    Constant Field Values
  - WEBSERVICES_REPOSITORY_SERVICE_ENDPOINT
```
public static final String WEBSERVICES_REPOSITORY_SERVICE_ENDPOINT
```
    Endpoint URLs for Web Services.
    
    See Also:
    Constant Field Values
  - WEBSERVICES_NAVIGATION_SERVICE_ENDPOINT
```
public static final String WEBSERVICES_NAVIGATION_SERVICE_ENDPOINT
```
    See Also:
    Constant Field Values
  - WEBSERVICES_OBJECT_SERVICE_ENDPOINT
```
public static final String WEBSERVICES_OBJECT_SERVICE_ENDPOINT
```
    See Also:
    Constant Field Values
  - WEBSERVICES_VERSIONING_SERVICE_ENDPOINT
```
public static final String WEBSERVICES_VERSIONING_SERVICE_ENDPOINT
```
    See Also:
    Constant Field Values
  - WEBSERVICES_DISCOVERY_SERVICE_ENDPOINT
```
public static final String WEBSERVICES_DISCOVERY_SERVICE_ENDPOINT
```
    See Also:
    Constant Field Values
  - WEBSERVICES_RELATIONSHIP_SERVICE_ENDPOINT
```
public static final String WEBSERVICES_RELATIONSHIP_SERVICE_ENDPOINT
```
    See Also:
    Constant Field Values
  - WEBSERVICES_MULTIFILING_SERVICE_ENDPOINT
```
public static final String WEBSERVICES_MULTIFILING_SERVICE_ENDPOINT
```
    See Also:
    Constant Field Values
  - WEBSERVICES_POLICY_SERVICE_ENDPOINT
```
public static final String WEBSERVICES_POLICY_SERVICE_ENDPOINT
```
    See Also:
    Constant Field Values
  - WEBSERVICES_ACL_SERVICE_ENDPOINT
```
public static final String WEBSERVICES_ACL_SERVICE_ENDPOINT
```
    See Also:
    Constant Field Values
  - WEBSERVICES_MEMORY_THRESHOLD
```
public static final String WEBSERVICES_MEMORY_THRESHOLD
```
    See Also:
    Constant Field Values
  - WEBSERVICES_PORT_PROVIDER_CLASS
```
public static final String WEBSERVICES_PORT_PROVIDER_CLASS
```
    See Also:
    Constant Field Values
  - WEBSERVICES_JAXWS_IMPL
```
public static final String WEBSERVICES_JAXWS_IMPL
```
    See Also:
    Constant Field Values
  - BROWSER_URL
```
public static final String BROWSER_URL
```
    URL of the Browser Binding entry point.
    
    See Also:
    Constant Field Values
  - BROWSER_SUCCINCT
```
public static final String BROWSER_SUCCINCT
```
    See Also:
    Constant Field Values
  - LOCAL_FACTORY
```
public static final String LOCAL_FACTORY
```
    Factory class name for the local binding.
    
    See Also:
    Constant Field Values
  - AUTHENTICATION_PROVIDER_CLASS
```
public static final String AUTHENTICATION_PROVIDER_CLASS
```
    Class name of the authentication provider.
    
    See Also:
    Constant Field Values
  - AUTH_HTTP_BASIC
```
public static final String AUTH_HTTP_BASIC
```
    Toggle for HTTP basic authentication. Evaluated by the standard authentication provider.
    
    See Also:
    Constant Field Values
  - AUTH_SOAP_USERNAMETOKEN
```
public static final String AUTH_SOAP_USERNAMETOKEN
```
    Toggle for WS-Security UsernameToken authentication. Evaluated by the standard authentication provider.
    
    See Also:
    Constant Field Values
  - HTTP_INVOKER_CLASS
```
public static final String HTTP_INVOKER_CLASS
```
    See Also:
    Constant Field Values
  - COMPRESSION
```
public static final String COMPRESSION
```
    See Also:
    Constant Field Values
  - CLIENT_COMPRESSION
```
public static final String CLIENT_COMPRESSION
```
    See Also:
    Constant Field Values
  - COOKIES
```
public static final String COOKIES
```
    See Also:
    Constant Field Values
  - HEADER
```
public static final String HEADER
```
    See Also:
    Constant Field Values
  - CONNECT_TIMEOUT
```
public static final String CONNECT_TIMEOUT
```
    See Also:
    Constant Field Values
  - READ_TIMEOUT
```
public static final String READ_TIMEOUT
```
    See Also:
    Constant Field Values
  - PROXY_USER
```
public static final String PROXY_USER
```
    See Also:
    Constant Field Values
  - PROXY_PASSWORD
```
public static final String PROXY_PASSWORD
```
    See Also:
    Constant Field Values
  - CACHE_SIZE_OBJECTS
```
public static final String CACHE_SIZE_OBJECTS
```
    See Also:
    Constant Field Values
  - CACHE_TTL_OBJECTS
```
public static final String CACHE_TTL_OBJECTS
```
    See Also:
    Constant Field Values
  - CACHE_SIZE_PATHTOID
```
public static final String CACHE_SIZE_PATHTOID
```
    See Also:
    Constant Field Values
  - CACHE_TTL_PATHTOID
```
public static final String CACHE_TTL_PATHTOID
```
    See Also:
    Constant Field Values
  - CACHE_PATH_OMIT
```
public static final String CACHE_PATH_OMIT
```
    See Also:
    Constant Field Values
  - CACHE_SIZE_REPOSITORIES
```
public static final String CACHE_SIZE_REPOSITORIES
```
    See Also:
    Constant Field Values
  - CACHE_SIZE_TYPES
```
public static final String CACHE_SIZE_TYPES
```
    See Also:
    Constant Field Values
  - CACHE_SIZE_LINKS
```
public static final String CACHE_SIZE_LINKS
```
    See Also:
    Constant Field Values
  - LOCALE_ISO639_LANGUAGE
```
public static final String LOCALE_ISO639_LANGUAGE
```
    See Also:
    Constant Field Values
  - LOCALE_ISO3166_COUNTRY
```
public static final String LOCALE_ISO3166_COUNTRY
```
    See Also:
    Constant Field Values
  - LOCALE_VARIANT
```
public static final String LOCALE_VARIANT
```
    See Also:
    Constant Field Values
  - OBJECT_FACTORY_CLASS
```
public static final String OBJECT_FACTORY_CLASS
```
    See Also:
    Constant Field Values
  - CACHE_CLASS
```
public static final String CACHE_CLASS
```
    See Also:
    Constant Field Values
  - REPOSITORY_ID
```
public static final String REPOSITORY_ID
```
    See Also:
    Constant Field Values

Class SessionParameter

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER

PASSWORD

BINDING_TYPE

BINDING_SPI_CLASS

ATOMPUB_URL

WEBSERVICES_REPOSITORY_SERVICE

WEBSERVICES_NAVIGATION_SERVICE

WEBSERVICES_OBJECT_SERVICE

WEBSERVICES_VERSIONING_SERVICE

WEBSERVICES_DISCOVERY_SERVICE

WEBSERVICES_RELATIONSHIP_SERVICE

WEBSERVICES_MULTIFILING_SERVICE

WEBSERVICES_POLICY_SERVICE

WEBSERVICES_ACL_SERVICE

WEBSERVICES_REPOSITORY_SERVICE_ENDPOINT

WEBSERVICES_NAVIGATION_SERVICE_ENDPOINT

WEBSERVICES_OBJECT_SERVICE_ENDPOINT

WEBSERVICES_VERSIONING_SERVICE_ENDPOINT

WEBSERVICES_DISCOVERY_SERVICE_ENDPOINT

WEBSERVICES_RELATIONSHIP_SERVICE_ENDPOINT

WEBSERVICES_MULTIFILING_SERVICE_ENDPOINT

WEBSERVICES_POLICY_SERVICE_ENDPOINT

WEBSERVICES_ACL_SERVICE_ENDPOINT

WEBSERVICES_MEMORY_THRESHOLD

WEBSERVICES_PORT_PROVIDER_CLASS

WEBSERVICES_JAXWS_IMPL

BROWSER_URL

BROWSER_SUCCINCT

LOCAL_FACTORY

AUTHENTICATION_PROVIDER_CLASS

AUTH_HTTP_BASIC

AUTH_SOAP_USERNAMETOKEN

HTTP_INVOKER_CLASS

COMPRESSION

CLIENT_COMPRESSION

COOKIES

HEADER

CONNECT_TIMEOUT

READ_TIMEOUT

PROXY_USER

PROXY_PASSWORD

CACHE_SIZE_OBJECTS

CACHE_TTL_OBJECTS

CACHE_SIZE_PATHTOID

CACHE_TTL_PATHTOID

CACHE_PATH_OMIT

CACHE_SIZE_REPOSITORIES

CACHE_SIZE_TYPES

CACHE_SIZE_LINKS

LOCALE_ISO639_LANGUAGE

LOCALE_ISO3166_COUNTRY

LOCALE_VARIANT

OBJECT_FACTORY_CLASS

CACHE_CLASS

REPOSITORY_ID