AbstractClientProperties (Atlassian Integration Client Common 2.9.7 API)

java.lang.Object
- com.atlassian.crowd.service.client.AbstractClientProperties

All Implemented Interfaces:: ClientProperties

Direct Known Subclasses:: ClientPropertiesImpl

public abstract class AbstractClientProperties
extends Object
implements ClientProperties

Field Summary

Fields
Modifier and Type	Field and Description
`protected ApplicationAuthenticationContext`	`applicationAuthenticationContext`
`protected String`	`applicationAuthenticationURL`
`protected String`	`applicationName`
`protected String`	`applicationPassword`
`protected String`	`asapIssuer`
`protected String`	`asapKeyIdentifier`
`protected boolean`	`asapSubjectRequired`
`protected AuthenticationMethod`	`authenticationMethod`
`protected String`	`baseURL`
`protected String`	`cookieTokenKey`
`protected String`	`httpMaxConnections`
`protected String`	`httpProxyHost`
`protected String`	`httpProxyPassword`
`protected String`	`httpProxyPort`
`protected String`	`httpProxyUsername`
`protected String`	`httpTimeout`
`protected String`	`sessionLastValidation`
`protected String`	`sessionTokenKey`
`protected long`	`sessionValidationInterval`
`protected String`	`socketTimeout`
`protected String`	`ssoCookieDomainName`

Constructor Summary

Constructors
Constructor and Description

AbstractClientProperties()

Constructors
Constructor and Description
`AbstractClientProperties()`

Method Summary

All Methods Instance Methods Concrete 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.
`String`	`getAsapIssuer()` Returns the ASAP issuer for the client (only relevant if `ClientProperties.getAuthenticationMethod()` returns ASAP).
`String`	`getAsapKeyIdentifier()` Returns the ASAP key identifier for the client (only relevant if `ClientProperties.getAuthenticationMethod()` returns ASAP).
`AuthenticationMethod`	`getAuthenticationMethod()`
`String`	`getBaseURL()` Returns the base URL of the client application.
`String`	`getCookieTokenKey()` Returns the key of the token cookie.
`String`	`getCookieTokenKey(String def)` 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()` Returns the key of the session cookie.
`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
`boolean`	`isAsapSubjectRequired()` Returns whether the `application name` should be used as the subject of the ASAP signature (only relevant if `ClientProperties.getAuthenticationMethod()` returns ASAP)
`String`	`toString()`

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

Methods inherited from interface com.atlassian.crowd.service.client.ClientProperties
updateProperties

- Field Detail
  - applicationName
```
protected String applicationName
```
  - applicationPassword
```
protected String applicationPassword
```
  - applicationAuthenticationURL
```
protected String applicationAuthenticationURL
```
  - cookieTokenKey
```
protected String cookieTokenKey
```
  - sessionTokenKey
```
protected String sessionTokenKey
```
  - sessionLastValidation
```
protected String sessionLastValidation
```
  - sessionValidationInterval
```
protected long sessionValidationInterval
```
  - baseURL
```
protected String baseURL
```
  - httpProxyPort
```
protected String httpProxyPort
```
  - httpProxyHost
```
protected String httpProxyHost
```
  - httpProxyUsername
```
protected String httpProxyUsername
```
  - httpProxyPassword
```
protected String httpProxyPassword
```
  - httpMaxConnections
```
protected String httpMaxConnections
```
  - httpTimeout
```
protected String httpTimeout
```
  - socketTimeout
```
protected String socketTimeout
```
  - ssoCookieDomainName
```
protected String ssoCookieDomainName
```
  - authenticationMethod
```
protected AuthenticationMethod authenticationMethod
```
  - asapKeyIdentifier
```
protected String asapKeyIdentifier
```
  - asapIssuer
```
protected String asapIssuer
```
  - asapSubjectRequired
```
protected boolean asapSubjectRequired
```
  - applicationAuthenticationContext
```
protected ApplicationAuthenticationContext applicationAuthenticationContext
```
- Constructor Detail
  - AbstractClientProperties
```
public AbstractClientProperties()
```
- Method Detail
  - getApplicationName
```
public String getApplicationName()
```
    Description copied from interface: ClientProperties
    
    Returns the application name. Used in application authentication.
    
    Specified by:
    
    getApplicationName in interface ClientProperties
    
    Returns:
    
    application name.
  - getApplicationPassword
```
public String getApplicationPassword()
```
    Description copied from interface: ClientProperties
    
    Returns the application password used for authenticating the application.
    
    Specified by:
    
    getApplicationPassword in interface ClientProperties
    
    Returns:
    
    application password.
  - getApplicationAuthenticationURL
```
public String getApplicationAuthenticationURL()
```
    Description copied from interface: ClientProperties
    
    Returns the URL of the application's authentication page.
    
    Specified by:
    
    getApplicationAuthenticationURL in interface ClientProperties
    
    Returns:
    
    URL of the application's authentication page
  - getCookieTokenKey
```
public String getCookieTokenKey()
```
    Description copied from interface: ClientProperties
    
    Returns the key of the token cookie.
    
    Specified by:
    
    getCookieTokenKey in interface ClientProperties
    
    Returns:
    
    key of the token cookie
  - getCookieTokenKey
```
public String getCookieTokenKey(String def)
```
    Description copied from interface: ClientProperties
    
    Returns the key of the token cookie, or the provided value if one isn't set.
    
    Specified by:
    
    getCookieTokenKey in interface ClientProperties
    
    Parameters:
    
    def - the value to use if no key is configured
    
    Returns:
    
    key of the token cookie
  - getSessionTokenKey
```
public String getSessionTokenKey()
```
    Description copied from interface: ClientProperties
    
    Returns the key of the session cookie.
    
    Specified by:
    
    getSessionTokenKey in interface ClientProperties
    
    Returns:
    
    key of the session cookie
  - getSessionLastValidation
```
public String getSessionLastValidation()
```
    Description copied from interface: ClientProperties
    
    Returns the session attribute key of the last validation date.
    
    Specified by:
    
    getSessionLastValidation in interface ClientProperties
    
    Returns:
    
    the session attribute key of the last validation date
  - getSessionValidationInterval
```
public long getSessionValidationInterval()
```
    Description copied from interface: ClientProperties
    
    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.
    
    Specified by:
    
    getSessionValidationInterval in interface ClientProperties
    
    Returns:
    
    how long the SSO session is valid for in minutes between session validation
  - getApplicationAuthenticationContext
```
public ApplicationAuthenticationContext getApplicationAuthenticationContext()
```
    Description copied from interface: ClientProperties
    
    Returns the application authentication details.
    
    Specified by:
    
    getApplicationAuthenticationContext in interface ClientProperties
    
    Returns:
    
    application authentication details
  - getHttpProxyPort
```
public String getHttpProxyPort()
```
    Description copied from interface: ClientProperties
    
    Returns the HTTP proxy port number.
    
    Specified by:
    
    getHttpProxyPort in interface ClientProperties
    
    Returns:
    
    HTTP proxy port number
  - getHttpProxyHost
```
public String getHttpProxyHost()
```
    Description copied from interface: ClientProperties
    
    Returns the HTTP proxy host.
    
    Specified by:
    
    getHttpProxyHost in interface ClientProperties
    
    Returns:
    
    HTTP proxy host
  - getHttpProxyUsername
```
public String getHttpProxyUsername()
```
    Description copied from interface: ClientProperties
    
    Returns the HTTP proxy username.
    
    Specified by:
    
    getHttpProxyUsername in interface ClientProperties
    
    Returns:
    
    HTTP proxy username
  - getHttpProxyPassword
```
public String getHttpProxyPassword()
```
    Description copied from interface: ClientProperties
    
    Returns the HTTP proxy password.
    
    Specified by:
    
    getHttpProxyPassword in interface ClientProperties
    
    Returns:
    
    HTTP proxy password
  - getHttpMaxConnections
```
public String getHttpMaxConnections()
```
    Description copied from interface: ClientProperties
    
    Returns the maximum number of HTTP connections.
    
    Specified by:
    
    getHttpMaxConnections in interface ClientProperties
    
    Returns:
    
    maximum number of HTTP connections
  - getHttpTimeout
```
public String getHttpTimeout()
```
    Description copied from interface: ClientProperties
    
    Returns the HTTP connection timeout value in milliseconds.
    
    Specified by:
    
    getHttpTimeout in interface ClientProperties
    
    Returns:
    
    HTTP connection timeout values in milliseconds
  - getSocketTimeout
```
public String getSocketTimeout()
```
    Description copied from interface: ClientProperties
    
    Returns in milliseconds how long to wait without retrieving any data from the remote connection.
    
    Specified by:
    
    getSocketTimeout in interface ClientProperties
    
    Returns:
    
    socket timeout value in milliseconds
  - getBaseURL
```
public String getBaseURL()
```
    Description copied from interface: ClientProperties
    
    Returns the base URL of the client application.
    
    Specified by:
    
    getBaseURL in interface ClientProperties
    
    Returns:
    
    base URL of the client application
  - getSSOCookieDomainName
```
public String getSSOCookieDomainName()
```
    Description copied from interface: ClientProperties
    
    Returns the domain name configured for the SSO client
    
    Specified by:
    
    getSSOCookieDomainName in interface ClientProperties
    
    Returns:
    
    cookie domain name
  - getAuthenticationMethod
```
public AuthenticationMethod getAuthenticationMethod()
```
    Specified by:
    
    getAuthenticationMethod in interface ClientProperties
    
    Returns:
    
    the authentication protocol to be used by the client
  - getAsapKeyIdentifier
```
@Nullable
public String getAsapKeyIdentifier()
```
    Description copied from interface: ClientProperties
    
    Returns the ASAP key identifier for the client (only relevant if ClientProperties.getAuthenticationMethod() returns ASAP).
    
    Specified by:
    
    getAsapKeyIdentifier in interface ClientProperties
    
    Returns:
    
    ASAP key identifier, or null if not configured
  - getAsapIssuer
```
@Nullable
public String getAsapIssuer()
```
    Description copied from interface: ClientProperties
    
    Returns the ASAP issuer for the client (only relevant if ClientProperties.getAuthenticationMethod() returns ASAP).
    
    Specified by:
    
    getAsapIssuer in interface ClientProperties
    
    Returns:
    
    ASAP issuer for the client, or null if not configured
  - isAsapSubjectRequired
```
public boolean isAsapSubjectRequired()
```
    Description copied from interface: ClientProperties
    
    Returns whether the application name should be used as the subject of the ASAP signature (only relevant if ClientProperties.getAuthenticationMethod() returns ASAP)
    
    Specified by:
    
    isAsapSubjectRequired in interface ClientProperties
    
    Returns:
    
    true if application name should be used as the subject, false if no subject should be used in the ASAP signature
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractClientProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.crowd.service.client.ClientProperties

Field Detail

applicationName

applicationPassword

applicationAuthenticationURL

cookieTokenKey

sessionTokenKey

sessionLastValidation

sessionValidationInterval

baseURL

httpProxyPort

httpProxyHost

httpProxyUsername

httpProxyPassword

httpMaxConnections

httpTimeout

socketTimeout

ssoCookieDomainName

authenticationMethod

asapKeyIdentifier

asapIssuer

asapSubjectRequired

applicationAuthenticationContext

Constructor Detail

AbstractClientProperties

Method Detail

getApplicationName

getApplicationPassword

getApplicationAuthenticationURL

getCookieTokenKey

getCookieTokenKey

getSessionTokenKey

getSessionLastValidation

getSessionValidationInterval

getApplicationAuthenticationContext

getHttpProxyPort

getHttpProxyHost

getHttpProxyUsername

getHttpProxyPassword

getHttpMaxConnections

getHttpTimeout

getSocketTimeout

getBaseURL

getSSOCookieDomainName

getAuthenticationMethod

getAsapKeyIdentifier

getAsapIssuer

isAsapSubjectRequired

toString