org.apache.chemistry.opencmis.commons.endpoints

Interface CmisAuthentication

All Superinterfaces:

Map<String,Object>

All Known Implementing Classes:

CmisAuthenticationImpl

public interface CmisAuthentication
extends Map<String,Object>

CMIS endpoint authentication information.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_BASIC
static String	AUTH_CERT
static String	AUTH_FORM
static String	AUTH_KERBEROS
static String	AUTH_LTPA
static String	AUTH_NONE
static String	AUTH_NTLM
static String	AUTH_OAUTH
static String	AUTH_OIDC
static String	AUTH_SAML
static String	AUTH_USERNAME_TOKEN
static String	KEY_DISPLAY_NAME
static String	KEY_DOCUMENTATION_URL
static String	KEY_PREFERENCE
static String	KEY_TYPE

Method Summary

Modifier and Type	Method and Description
String	getDisplayName()
String	getDocumentationUrl()
CmisEndpoint	getEndpoint() Returns the associated CMIS endpoint.
Integer	getPreference()
String	getType()
boolean	requiresCookies() Returns if this authentication method requires cookies.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Detail

KEY_TYPE

static final String KEY_TYPE

See Also:

Constant Field Values

KEY_DISPLAY_NAME

static final String KEY_DISPLAY_NAME

See Also:

Constant Field Values

KEY_DOCUMENTATION_URL

static final String KEY_DOCUMENTATION_URL

See Also:

Constant Field Values

KEY_PREFERENCE

static final String KEY_PREFERENCE

See Also:

Constant Field Values

AUTH_NONE

static final String AUTH_NONE

See Also:

Constant Field Values

AUTH_BASIC

static final String AUTH_BASIC

See Also:

Constant Field Values

AUTH_USERNAME_TOKEN

static final String AUTH_USERNAME_TOKEN

See Also:

Constant Field Values

AUTH_FORM

static final String AUTH_FORM

See Also:

Constant Field Values

AUTH_CERT

static final String AUTH_CERT

See Also:

Constant Field Values

AUTH_SAML

static final String AUTH_SAML

See Also:

Constant Field Values

AUTH_OAUTH

static final String AUTH_OAUTH

See Also:

Constant Field Values

AUTH_OIDC

static final String AUTH_OIDC

See Also:

Constant Field Values

AUTH_NTLM

static final String AUTH_NTLM

See Also:

Constant Field Values

AUTH_KERBEROS

static final String AUTH_KERBEROS

See Also:

Constant Field Values

AUTH_LTPA

static final String AUTH_LTPA

See Also:

Constant Field Values

Method Detail

getType

String getType()

getDisplayName

String getDisplayName()

getDocumentationUrl

String getDocumentationUrl()

getPreference

Integer getPreference()

getEndpoint

CmisEndpoint getEndpoint()

Returns the associated CMIS endpoint.

Returns:

the endpoint object, never null

requiresCookies

boolean requiresCookies()

Returns if this authentication method requires cookies. Implementations should take following into account:

• the authentication method (some methods require cookies to work)
• the binding and its cookie setting
• the CSRF settings

Returns:

true if cookies are required, false if cookies are not required (they may be recommended, though)