Package com.force.api

Class ApiConfig

java.lang.Object

com.force.api.ApiConfig

public class ApiConfig
extends Object

Constructor Summary

Constructors

Constructor	Description
ApiConfig()

Method Summary

Modifier and Type	Method	Description
ApiConfig	clone()
ApiVersion	getApiVersion()	Deprecated. use #getApiVersionString instead
String	getApiVersionString()
String	getClientId()
String	getClientSecret()
String	getLoginEndpoint()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
String	getPassword()
String	getRedirectURI()
int	getRequestTimeout()
SessionRefreshListener	getSessionRefreshListener()
String	getUsername()
ApiConfig	setApiVersion(ApiVersion value)
ApiConfig	setApiVersionString(String value)
ApiConfig	setClientId(String value)
ApiConfig	setClientSecret(String value)
ApiConfig	setForceURL(String url)
ApiConfig	setLoginEndpoint(String value)
ApiConfig	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
ApiConfig	setPassword(String value)
ApiConfig	setRedirectURI(String redirectURI)
ApiConfig	setRequestTimeout(int requestTimeout)	sets both connect timeout and read timeout on HttpUrlConnection to the specified value.
ApiConfig	setSessionRefreshListener(SessionRefreshListener value)
ApiConfig	setUsername(String value)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ApiConfig

public ApiConfig()

Method Details

clone

public ApiConfig clone()

Overrides:

clone in class Object

setForceURL

public ApiConfig setForceURL(String url)

setRedirectURI

public ApiConfig setRedirectURI(String redirectURI)

setApiVersion

public ApiConfig setApiVersion(ApiVersion value)

setApiVersionString

public ApiConfig setApiVersionString(String value)

setUsername

public ApiConfig setUsername(String value)

setPassword

public ApiConfig setPassword(String value)

setLoginEndpoint

public ApiConfig setLoginEndpoint(String value)

setClientId

public ApiConfig setClientId(String value)

setClientSecret

public ApiConfig setClientSecret(String value)

setSessionRefreshListener

public ApiConfig setSessionRefreshListener(SessionRefreshListener value)

setObjectMapper

public ApiConfig setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

setRequestTimeout

public ApiConfig setRequestTimeout(int requestTimeout)

sets both connect timeout and read timeout on HttpUrlConnection to the specified value. A value of 0 (zero) means no timeout. The default is no timeout.

Parameters:

requestTimeout - timeout in milliseconds. A value of 0 means no timeout.

Returns:

this ApiConfig instance

getUsername

public String getUsername()

getPassword

public String getPassword()

getLoginEndpoint

public String getLoginEndpoint()

getClientId

public String getClientId()

getClientSecret

public String getClientSecret()

getRedirectURI

public String getRedirectURI()

getSessionRefreshListener

public SessionRefreshListener getSessionRefreshListener()

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

getRequestTimeout

public int getRequestTimeout()

getApiVersion

public ApiVersion getApiVersion()

Deprecated.

use #getApiVersionString instead

Returns:

enum representing api version

getApiVersionString

public String getApiVersionString()