Class AbstractClientProperties
java.lang.Object
com.atlassian.crowd.service.client.AbstractClientProperties
- All Implemented Interfaces:
ClientProperties
- Direct Known Subclasses:
ClientPropertiesImpl
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ApplicationAuthenticationContextprotected Stringprotected Stringprotected Stringprotected AuthenticationMethodprotected booleanprotected longprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected longprotected Stringprotected String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the application authentication details.Returns the URL of the application's authentication page.Returns the application name.Returns the application password used for authenticating the application.longReturns the base URL of the client application.Returns the key of the token cookie.getCookieTokenKey(String def) Returns the key of the token cookie, or the provided value if one isn't set.Returns the maximum number of HTTP connections.Returns the HTTP proxy host.Returns the HTTP proxy password.Returns the HTTP proxy port number.Returns the HTTP proxy username.Returns the HTTP connection timeout value in milliseconds.Returns the session attribute key of the last validation date.Returns the key of the session cookie.longReturns how long the SSO session is valid for in minutes between session validation.Returns in milliseconds how long to wait without retrieving any data from the remote connection.Returns the domain name configured for the SSO clientbooleantoString()Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.atlassian.crowd.service.client.ClientProperties
updateProperties
-
Field Details
-
applicationName
-
applicationPassword
-
applicationAuthenticationURL
-
cookieTokenKey
-
sessionTokenKey
-
sessionLastValidation
-
sessionValidationInterval
protected long sessionValidationInterval -
baseURL
-
httpProxyPort
-
httpProxyHost
-
httpProxyUsername
-
httpProxyPassword
-
httpMaxConnections
-
httpTimeout
-
socketTimeout
-
ssoCookieDomainName
-
authenticationMethod
-
applicationAuthenticationContext
-
authenticationStateCacheEnabled
protected boolean authenticationStateCacheEnabled -
authenticationStateCacheTtlMinutes
protected long authenticationStateCacheTtlMinutes
-
-
Constructor Details
-
AbstractClientProperties
public AbstractClientProperties()
-
-
Method Details
-
getApplicationName
Description copied from interface:ClientPropertiesReturns the application name. Used in application authentication.- Specified by:
getApplicationNamein interfaceClientProperties- Returns:
- application name.
-
getApplicationPassword
Description copied from interface:ClientPropertiesReturns the application password used for authenticating the application.- Specified by:
getApplicationPasswordin interfaceClientProperties- Returns:
- application password.
-
getApplicationAuthenticationURL
Description copied from interface:ClientPropertiesReturns the URL of the application's authentication page.- Specified by:
getApplicationAuthenticationURLin interfaceClientProperties- Returns:
- URL of the application's authentication page
-
getCookieTokenKey
Description copied from interface:ClientPropertiesReturns the key of the token cookie.- Specified by:
getCookieTokenKeyin interfaceClientProperties- Returns:
- key of the token cookie
-
getCookieTokenKey
Description copied from interface:ClientPropertiesReturns the key of the token cookie, or the provided value if one isn't set.- Specified by:
getCookieTokenKeyin interfaceClientProperties- Parameters:
def- the value to use if no key is configured- Returns:
- key of the token cookie
-
getSessionTokenKey
Description copied from interface:ClientPropertiesReturns the key of the session cookie.- Specified by:
getSessionTokenKeyin interfaceClientProperties- Returns:
- key of the session cookie
-
getSessionLastValidation
Description copied from interface:ClientPropertiesReturns the session attribute key of the last validation date.- Specified by:
getSessionLastValidationin interfaceClientProperties- Returns:
- the session attribute key of the last validation date
-
getSessionValidationInterval
public long getSessionValidationInterval()Description copied from interface:ClientPropertiesReturns how long the SSO session is valid for in minutes between session validation. If the session has not been validated for the specified amount of time, it is considered expired.- Specified by:
getSessionValidationIntervalin interfaceClientProperties- Returns:
- how long the SSO session is valid for in minutes between session validation
-
getApplicationAuthenticationContext
Description copied from interface:ClientPropertiesReturns the application authentication details.- Specified by:
getApplicationAuthenticationContextin interfaceClientProperties- Returns:
- application authentication details
-
getHttpProxyPort
Description copied from interface:ClientPropertiesReturns the HTTP proxy port number.- Specified by:
getHttpProxyPortin interfaceClientProperties- Returns:
- HTTP proxy port number
-
getHttpProxyHost
Description copied from interface:ClientPropertiesReturns the HTTP proxy host.- Specified by:
getHttpProxyHostin interfaceClientProperties- Returns:
- HTTP proxy host
-
getHttpProxyUsername
Description copied from interface:ClientPropertiesReturns the HTTP proxy username.- Specified by:
getHttpProxyUsernamein interfaceClientProperties- Returns:
- HTTP proxy username
-
getHttpProxyPassword
Description copied from interface:ClientPropertiesReturns the HTTP proxy password.- Specified by:
getHttpProxyPasswordin interfaceClientProperties- Returns:
- HTTP proxy password
-
getHttpMaxConnections
Description copied from interface:ClientPropertiesReturns the maximum number of HTTP connections.- Specified by:
getHttpMaxConnectionsin interfaceClientProperties- Returns:
- maximum number of HTTP connections
-
getHttpTimeout
Description copied from interface:ClientPropertiesReturns the HTTP connection timeout value in milliseconds.- Specified by:
getHttpTimeoutin interfaceClientProperties- Returns:
- HTTP connection timeout values in milliseconds
-
getSocketTimeout
Description copied from interface:ClientPropertiesReturns in milliseconds how long to wait without retrieving any data from the remote connection.- Specified by:
getSocketTimeoutin interfaceClientProperties- Returns:
- socket timeout value in milliseconds
-
getBaseURL
Description copied from interface:ClientPropertiesReturns the base URL of the client application.- Specified by:
getBaseURLin interfaceClientProperties- Returns:
- base URL of the client application
-
getSSOCookieDomainName
Description copied from interface:ClientPropertiesReturns the domain name configured for the SSO client- Specified by:
getSSOCookieDomainNamein interfaceClientProperties- Returns:
- cookie domain name
-
getAuthenticationMethod
- Specified by:
getAuthenticationMethodin interfaceClientProperties- Returns:
- the authentication protocol to be used by the client
-
isAuthenticationStateCacheEnabled
public boolean isAuthenticationStateCacheEnabled()- Specified by:
isAuthenticationStateCacheEnabledin interfaceClientProperties- Returns:
true, ifAuthenticationStatecache is enabled forCrowdHttpAuthenticator,falseotherwise.
-
getAuthenticationStateCacheTtlMinutes
public long getAuthenticationStateCacheTtlMinutes()- Specified by:
getAuthenticationStateCacheTtlMinutesin interfaceClientProperties- Returns:
AuthenticationStatecache TTL in minutes forCrowdHttpAuthenticator.0means cache doesn't persist any values.
-
toString
-