org.apache.chemistry.opencmis.client

Class SessionParameterMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,String>

org.apache.chemistry.opencmis.client.SessionParameterMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String>

public class SessionParameterMap
extends LinkedHashMap<String,String>

A map with convenience methods to set session parameters.

Sample code:

 SessionFactory factory = ...
 
 SessionParameterMap parameter = new SessionParameterMap();
 
 parameter.setBasicAuthentication("Otto", "****");
 parameter.setAtomPubBindingUrl("http://localhost/cmis/atom");
 parameter.setRepositoryId("myRepository");
 ...
 Session session = factory.createSession(parameter);
 

See Also:

SessionParameter, SessionFactory, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
SessionParameterMap() Creates an empty map.
SessionParameterMap(Map<? extends String,? extends String> map) Creates a map with the same mappings as the specified map.

Method Summary

Modifier and Type	Method and Description
void	addHeader(String header, String value) Adds a HTTP header.
void	load(File file) Loads entries from the given UTF-8 encoded file.
void	load(InputStream stream) Loads entries from the given, UTF-8 encoded stream and leaves the stream open.
void	parse(String parameters) Parses a string that contains key-value pairs.
String	put(String key, boolean value) Sets a boolean value.
String	put(String key, long value) Sets a long value.
protected void	putLine(String line)
void	setAtomPubBindingUrl(String url) Sets the AtomPub URL and sets the binding to AtomPub.
void	setAuthenticationProvider(Class<? extends AuthenticationProvider> authenticationProviderClass) Sets the authentication provider class.
void	setBasicAuthentication() Turns basic authentication on and UsernameToken authentication off if the standard authentication provider is used.
void	setBasicAuthentication(String user, String password) Turns basic authentication on and UsernameToken authentication off if the standard authentication provider is used.
void	setBearerToken(String token) Sets bearer token.
void	setBrowserBindingSuccinct(boolean succinct) Sets whether properties should be sent in the succinct format or not.
void	setBrowserBindingUrl(String url) Sets the Browser URL and sets the binding to Browser.
void	setCertificateAuthentication(String keyfilePath, String passphrase) Turns Client Certificate authentication on and and basic authentication and UsernameToken authentication off.
void	setClientCompression(boolean compression) Sets whether requests to the server should be compressed or not.
void	setCompression(boolean compression) Sets if the server should be asked to use compression.
void	setConnectionTimeout(long timeout) Sets the HTTP connection timeout.
void	setCookies(boolean cookies) Sets whether cookies should be managed or not.
void	setCsrfHeader(String csrfHeader) Sets the CSRF HTTP header
void	setDefaultLocale() Sets the JVM default locale of the session.
void	setHttpInvoker(Class<?> httpInvokerClass) Sets the HTTP invoker class.
void	setLocalBindingClass(Class<? extends CmisServiceFactory> serviceFactoryClass) Sets the local service factory and sets the binding to Local.
void	setLocale(Locale locale) Sets the locale of the session.
void	setLocale(String language) Sets the locale of the session.
void	setLocale(String language, String country) Sets the locale of the session.
void	setNoAuthentication() Turns all authentication off if the standard authentication provider is used.
void	setNtlmAuthentication() Turns NTLM authentication on and basic authentication and UsernameToken authentication off.
void	setNtlmAuthentication(String user, String password) Turns NTLM authentication on and basic authentication and UsernameToken authentication off.
void	setOAuthAuthentication() Turns OAuth 2.0 authentication on and basic authentication and UsernameToken authentication off.
void	setOAuthAuthentication(String tokenEntpoint, String clientId, String clientSecret, String code, String redirectUri) Turns OAuth 2.0 authentication on and basic authentication and UsernameToken authentication off.
void	setOAuthAuthentication(String tokenEntpoint, String clientId, String clientSecret, String accessToken, String refreshToken, long expirationTimestamp) Turns OAuth 2.0 authentication on and basic authentication and UsernameToken authentication off.
void	setOAuthBearerTokenAuthentication(String token) Turns simple OAuth 2.0 bearer token authentication on and basic authentication and UsernameToken authentication off.
void	setObjectFactory(Class<? extends ObjectFactory> objectFactoryClass) Sets the object factory class.
void	setProxyUserAndPassword(String user, String password) Sets HTTP proxy user and password.
void	setReadTimeout(long timeout) Sets the HTTP read timeout.
void	setRepositoryId(String repositoryId) Sets the repository ID.
void	setUserAgent(String userAgent) Sets the user agent string.
void	setUserAndPassword(String user, String password) Sets user and password.
void	setUsernameTokenAuthentication(boolean basicAuth) Turns UsernameToken authentication on for the Web Services binding if the standard authentication provider is used.
void	setUsernameTokenAuthentication(String user, String password, boolean basicAuth) Turns UsernameToken authentication on for the Web Services binding if the standard authentication provider is used.
void	setWebServicesBindingUrl(String url) Sets the Web Services WSDL URL and sets the binding to Web Services.
void	setWebServicesMemoryTempDirectory(String tempDir, boolean encrypt) Sets the Web Service temp directory.
void	setWebServicesMemoryThreshold(long threshold) Sets the Web Service memory threshold.
void	store(File file) Writes all entries to the given file.
void	store(OutputStream stream) Writes all entries UTF-8 encoded to the given stream and leaves the stream open.
String	toString()

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Detail

SessionParameterMap

public SessionParameterMap()

Creates an empty map.

SessionParameterMap

public SessionParameterMap(Map<? extends String,? extends String> map)

Creates a map with the same mappings as the specified map.

Parameters:

map - the map whose mappings are to be placed in this map

Method Detail

put

public String put(String key,
                  long value)

Sets a long value.

Parameters:

key - the key

value - the value

Returns:

the previous value for this key or null

put

public String put(String key,
                  boolean value)

Sets a boolean value.

Parameters:

key - the key

value - the value

Returns:

the previous value for this key or null

setAtomPubBindingUrl

public void setAtomPubBindingUrl(String url)

Sets the AtomPub URL and sets the binding to AtomPub.

Parameters:

url - the AtomPub binding URL

setWebServicesBindingUrl

public void setWebServicesBindingUrl(String url)

Sets the Web Services WSDL URL and sets the binding to Web Services. Assumes that all CMIS services have the same WSDL URL.

Parameters:

url - the Web Services WSDL URL

setWebServicesMemoryThreshold

public void setWebServicesMemoryThreshold(long threshold)

Sets the Web Service memory threshold.

Parameters:

threshold - the threshold in bytes

setWebServicesMemoryTempDirectory

public void setWebServicesMemoryTempDirectory(String tempDir,
                                              boolean encrypt)

Sets the Web Service temp directory.

Parameters:

tempDir - path of the temp directory

encrypt - true if temp files should be encrypted, false otherwise

setBrowserBindingUrl

public void setBrowserBindingUrl(String url)

Sets the Browser URL and sets the binding to Browser.

Parameters:

url - the Browser binding URL

setBrowserBindingSuccinct

public void setBrowserBindingSuccinct(boolean succinct)

Sets whether properties should be sent in the succinct format or not. Only relevant for the browser binding.

Parameters:

succinct - true if properties should be sent in the succinct format, false otherwise

setLocalBindingClass

public void setLocalBindingClass(Class<? extends CmisServiceFactory> serviceFactoryClass)

Sets the local service factory and sets the binding to Local.

Parameters:

serviceFactoryClass - the local service factory class

setRepositoryId

public void setRepositoryId(String repositoryId)

Sets the repository ID.

Parameters:

repositoryId - the repository ID

setUserAndPassword

public void setUserAndPassword(String user,
                               String password)

Sets user and password.

Parameters:

user - the user

password - the password

setBearerToken

public void setBearerToken(String token)

Sets bearer token.

Parameters:

token - the bearer token

setNoAuthentication

public void setNoAuthentication()

Turns all authentication off if the standard authentication provider is used.

setBasicAuthentication

public void setBasicAuthentication(String user,
                                   String password)

Turns basic authentication on and UsernameToken authentication off if the standard authentication provider is used.

Parameters:

user - the user

password - the password

setBasicAuthentication

public void setBasicAuthentication()

Turns basic authentication on and UsernameToken authentication off if the standard authentication provider is used.

setUsernameTokenAuthentication

public void setUsernameTokenAuthentication(String user,
                                           String password,
                                           boolean basicAuth)

Turns UsernameToken authentication on for the Web Services binding if the standard authentication provider is used.

Parameters:

user - the user

password - the password

basicAuth - true if basic authentication should be used in addition to the UsernameToken authentication (required by some servers), false otherwise

setUsernameTokenAuthentication

public void setUsernameTokenAuthentication(boolean basicAuth)

Turns UsernameToken authentication on for the Web Services binding if the standard authentication provider is used.

Parameters:

basicAuth - true if basic authentication should be used in addition to the UsernameToken authentication (required by some servers), false otherwise

setNtlmAuthentication

public void setNtlmAuthentication(String user,
                                  String password)

Turns NTLM authentication on and basic authentication and UsernameToken authentication off.

Works only in single user environments and only with NTLMv1!

Parameters:

user - the user

password - the password

setNtlmAuthentication

public void setNtlmAuthentication()

Turns NTLM authentication on and basic authentication and UsernameToken authentication off.

Works only in single user environments and only with NTLMv1!

setCertificateAuthentication

public void setCertificateAuthentication(String keyfilePath,
                                         String passphrase)

Turns Client Certificate authentication on and and basic authentication and UsernameToken authentication off.

Parameters:

keyfilePath - the path to the JKS key file

passphrase - the pass phrase for the key file

setOAuthBearerTokenAuthentication

public void setOAuthBearerTokenAuthentication(String token)

Turns simple OAuth 2.0 bearer token authentication on and basic authentication and UsernameToken authentication off.

This authentication method does not refresh the token when it expires.

Parameters:

token - the bearer token

setOAuthAuthentication

public void setOAuthAuthentication(String tokenEntpoint,
                                   String clientId,
                                   String clientSecret,
                                   String code,
                                   String redirectUri)

Turns OAuth 2.0 authentication on and basic authentication and UsernameToken authentication off.

This authentication method requests a new token and refreshes the token when it expires.

Parameters:

tokenEntpoint - the token endpoint URL

clientId - the client ID

clientSecret - the client secret if required, null otherwise

code - the authorization code

redirectUri - the redirect URI if required, null otherwise

setOAuthAuthentication

public void setOAuthAuthentication(String tokenEntpoint,
                                   String clientId,
                                   String clientSecret,
                                   String accessToken,
                                   String refreshToken,
                                   long expirationTimestamp)

Turns OAuth 2.0 authentication on and basic authentication and UsernameToken authentication off.

This authentication method uses the provided token and refreshes the token when it expires.

Parameters:

tokenEntpoint - the token endpoint URL

clientId - the client ID

clientSecret - the client secret if required, null otherwise

accessToken - the bearer access token

refreshToken - the refresh token

expirationTimestamp - the timestamp when the access token expires

setOAuthAuthentication

public void setOAuthAuthentication()

Turns OAuth 2.0 authentication on and basic authentication and UsernameToken authentication off.

setLocale

public void setLocale(Locale locale)

Sets the locale of the session.

Parameters:

locale - the locale

setLocale

public void setLocale(String language,
                      String country)

Sets the locale of the session.

Parameters:

language - ISO 639 language code

country - ISO 3166 country code

setLocale

public void setLocale(String language)

Sets the locale of the session.

Parameters:

language - ISO 639 language code

setDefaultLocale

public void setDefaultLocale()

Sets the JVM default locale of the session.

setCookies

public void setCookies(boolean cookies)

Sets whether cookies should be managed or not.

Parameters:

cookies - true if cookies should be managed, false otherwise

setCompression

public void setCompression(boolean compression)

Sets if the server should be asked to use compression.

Parameters:

compression - true if the server should be asked to use compression, false otherwise

setUserAgent

public void setUserAgent(String userAgent)

Sets the user agent string.

Parameters:

userAgent - the user agent string

setClientCompression

public void setClientCompression(boolean compression)

Sets whether requests to the server should be compressed or not.

Parameters:

compression - true if requests should be compressed, false otherwise

setCsrfHeader

public void setCsrfHeader(String csrfHeader)

Sets the CSRF HTTP header

Parameters:

csrfHeader - name of the CSRF header

setConnectionTimeout

public void setConnectionTimeout(long timeout)

Sets the HTTP connection timeout.

Parameters:

timeout - the connection timeout in milliseconds

setReadTimeout

public void setReadTimeout(long timeout)

Sets the HTTP read timeout.

Parameters:

timeout - the read timeout in milliseconds

setHttpInvoker

public void setHttpInvoker(Class<?> httpInvokerClass)

Sets the HTTP invoker class.

Parameters:

httpInvokerClass - the HTTP invoker class

addHeader

public void addHeader(String header,
                      String value)

Adds a HTTP header.

Parameters:

header - the header name

value - the header value

setProxyUserAndPassword

public void setProxyUserAndPassword(String user,
                                    String password)

Sets HTTP proxy user and password.

Parameters:

user - the user

password - the password

setAuthenticationProvider

public void setAuthenticationProvider(Class<? extends AuthenticationProvider> authenticationProviderClass)

Sets the authentication provider class.

Parameters:

authenticationProviderClass - the authentication provider class

setObjectFactory

public void setObjectFactory(Class<? extends ObjectFactory> objectFactoryClass)

Sets the object factory class.

Parameters:

objectFactoryClass - the object factory class

load

public void load(File file)
          throws IOException

Loads entries from the given UTF-8 encoded file.

Parameters:

file - the file

Throws:

IOException - if the entries cannot be read

See Also:

load(InputStream)

load

public void load(InputStream stream)
          throws IOException

Loads entries from the given, UTF-8 encoded stream and leaves the stream open. Empty lines and lines starting with '#' are ignored. Entries are added and replaced.

Parameters:

stream - the stream

Throws:

IOException - if the entries cannot be read

parse

public void parse(String parameters)

Parses a string that contains key-value pairs.

Parameters:

parameters - the parameters string

putLine

protected void putLine(String line)

store

public final void store(File file)
                 throws IOException

Writes all entries to the given file.

Parameters:

file - the file

Throws:

IOException - if the entries cannot be written

See Also:

store(OutputStream)

store

public void store(OutputStream stream)
           throws IOException

Writes all entries UTF-8 encoded to the given stream and leaves the stream open.

Parameters:

stream - the stream

Throws:

IOException - if the entries cannot be written

toString

public String toString()

Overrides:

toString in class AbstractMap<String,String>