ClientProperties (Atlassian Crowd 4.0.0 API)

All Known Subinterfaces:

OpenIDServerClientProperties, SoapClientProperties

All Known Implementing Classes:

AbstractClientProperties, ClientPropertiesImpl, CrowdServerClientProperties, OpenIDServerClientPropertiesImpl, SoapClientPropertiesImpl
```
public interface ClientProperties
```
Properties required for the Crowd Client. Normally the properties are stored in crowd.properties file.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`ApplicationAuthenticationContext`	`getApplicationAuthenticationContext()` Returns the application authentication details.
`String`	`getApplicationAuthenticationURL()` Returns the URL of the application's authentication page.
`String`	`getApplicationName()` Returns the application name.
`String`	`getApplicationPassword()` Returns the application password used for authenticating the application.
`AuthenticationMethod`	`getAuthenticationMethod()`
`String`	`getBaseURL()` Returns the base URL of the client application.
`String`	`getCookieTokenKey()` Returns the key of the token cookie.
`String`	`getCookieTokenKey(String defaultKey)` Returns the key of the token cookie, or the provided value if one isn't set.
`String`	`getHttpMaxConnections()` Returns the maximum number of HTTP connections.
`String`	`getHttpProxyHost()` Returns the HTTP proxy host.
`String`	`getHttpProxyPassword()` Returns the HTTP proxy password.
`String`	`getHttpProxyPort()` Returns the HTTP proxy port number.
`String`	`getHttpProxyUsername()` Returns the HTTP proxy username.
`String`	`getHttpTimeout()` Returns the HTTP connection timeout value in milliseconds.
`String`	`getSessionLastValidation()` Returns the session attribute key of the last validation date.
`String`	`getSessionTokenKey()` Deprecated. Not set by current Crowd versions. Since v3.0.
`long`	`getSessionValidationInterval()` Returns how long the SSO session is valid for in minutes between session validation.
`String`	`getSocketTimeout()` Returns in milliseconds how long to wait without retrieving any data from the remote connection.
`String`	`getSSOCookieDomainName()` Returns the domain name configured for the SSO client
`void`	`updateProperties(Properties properties)` Updates all the properties with the new values.

- Method Detail
  - updateProperties
```
void updateProperties(Properties properties)
```
    Updates all the properties with the new values.
    
    Parameters:
    
    properties - properties to update from
  - getApplicationName
```
String getApplicationName()
```
    Returns the application name. Used in application authentication.
    
    Returns:
    
    application name.
  - getApplicationPassword
```
String getApplicationPassword()
```
    Returns the application password used for authenticating the application.
    
    Returns:
    
    application password.
  - getApplicationAuthenticationURL
```
String getApplicationAuthenticationURL()
```
    Returns the URL of the application's authentication page.
    
    Returns:
    
    URL of the application's authentication page
  - getCookieTokenKey
```
String getCookieTokenKey()
```
    Returns the key of the token cookie.
    
    Returns:
    
    key of the token cookie
  - getCookieTokenKey
```
String getCookieTokenKey(String defaultKey)
```
    Returns the key of the token cookie, or the provided value if one isn't set.
    
    Parameters:
    
    defaultKey - the value to use if no key is configured
    
    Returns:
    
    key of the token cookie
  - getSessionTokenKey
```
@Deprecated
String getSessionTokenKey()
```
    Deprecated. Not set by current Crowd versions. Since v3.0.
    
    Returns the key of the session cookie.
    
    Returns:
    
    key of the session cookie
  - getSessionLastValidation
```
String getSessionLastValidation()
```
    Returns the session attribute key of the last validation date.
    
    Returns:
    
    the session attribute key of the last validation date
  - getSessionValidationInterval
```
long getSessionValidationInterval()
```
    Returns 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.
    
    Returns:
    
    how long the SSO session is valid for in minutes between session validation
  - getApplicationAuthenticationContext
```
ApplicationAuthenticationContext getApplicationAuthenticationContext()
```
    Returns the application authentication details.
    
    Returns:
    
    application authentication details
  - getHttpProxyPort
```
String getHttpProxyPort()
```
    Returns the HTTP proxy port number.
    
    Returns:
    
    HTTP proxy port number
  - getHttpProxyHost
```
String getHttpProxyHost()
```
    Returns the HTTP proxy host.
    
    Returns:
    
    HTTP proxy host
  - getHttpProxyUsername
```
String getHttpProxyUsername()
```
    Returns the HTTP proxy username.
    
    Returns:
    
    HTTP proxy username
  - getHttpProxyPassword
```
String getHttpProxyPassword()
```
    Returns the HTTP proxy password.
    
    Returns:
    
    HTTP proxy password
  - getHttpMaxConnections
```
String getHttpMaxConnections()
```
    Returns the maximum number of HTTP connections.
    
    Returns:
    
    maximum number of HTTP connections
  - getHttpTimeout
```
String getHttpTimeout()
```
    Returns the HTTP connection timeout value in milliseconds.
    
    Returns:
    
    HTTP connection timeout values in milliseconds
  - getSocketTimeout
```
String getSocketTimeout()
```
    Returns in milliseconds how long to wait without retrieving any data from the remote connection.
    
    Returns:
    
    socket timeout value in milliseconds
  - getBaseURL
```
String getBaseURL()
```
    Returns the base URL of the client application.
    
    Returns:
    
    base URL of the client application
  - getSSOCookieDomainName
```
String getSSOCookieDomainName()
```
    Returns the domain name configured for the SSO client
    
    Returns:
    
    cookie domain name
  - getAuthenticationMethod
```
@Nonnull
AuthenticationMethod getAuthenticationMethod()
```
    Returns:
    
    the authentication protocol to be used by the client
    
    Since:
    
    2.9

Interface ClientProperties

Method Summary

Method Detail

updateProperties

getApplicationName

getApplicationPassword

getApplicationAuthenticationURL

getCookieTokenKey

getCookieTokenKey

getSessionTokenKey

getSessionLastValidation

getSessionValidationInterval

getApplicationAuthenticationContext

getHttpProxyPort

getHttpProxyHost

getHttpProxyUsername

getHttpProxyPassword

getHttpMaxConnections

getHttpTimeout

getSocketTimeout

getBaseURL

getSSOCookieDomainName

getAuthenticationMethod