Package com.github.scribejava.apis

Class SalesforceApi

java.lang.Object

com.github.scribejava.core.builder.api.DefaultApi20

com.github.scribejava.apis.SalesforceApi

public class SalesforceApi
extends DefaultApi20

This class is an implementation of the Salesforce OAuth2 API. The default implementation connects to the Salesforce production environment. If you want to connect to a Sandbox environment you've to use sandbox() method to get sandbox instance of this API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SalesforceApi.InstanceHolder

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	ACCESS_PATH
private java.lang.String	accessTokenUrl
private java.lang.String	authorizationBaseUrl
private static java.lang.String	AUTHORIZE_PATH
private static java.lang.String	PRODUCTION_HOST
private static java.lang.String	PROTOCOL
private static java.lang.String	SANDBOX_HOST

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SalesforceApi(java.lang.String hostName)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAccessTokenEndpoint()	Returns the URL that receives the access token requests.
TokenExtractor<OAuth2AccessToken>	getAccessTokenExtractor()	Returns the access token extractor.
Verb	getAccessTokenVerb()	Returns the verb for the access token endpoint (defaults to POST)
protected java.lang.String	getAuthorizationBaseUrl()
ClientAuthentication	getClientAuthentication()
static void	initTLSv11orUpper()	Salesforce API requires to use TLSv1.1 or upper.
static SalesforceApi	instance()
private static boolean	isTLSv11orUpperEnabled(javax.net.ssl.SSLSocket socket)
static SalesforceApi	sandbox()

Methods inherited from class com.github.scribejava.core.builder.api.DefaultApi20

createService, getAuthorizationUrl, getBearerSignature, getDeviceAuthorizationEndpoint, getDeviceAuthorizationExtractor, getRefreshTokenEndpoint, getRevokeTokenEndpoint

Methods inherited from class java.lang.Object

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

Field Detail

PRODUCTION_HOST

private static final java.lang.String PRODUCTION_HOST

See Also:

Constant Field Values

SANDBOX_HOST

private static final java.lang.String SANDBOX_HOST

See Also:

Constant Field Values

PROTOCOL

private static final java.lang.String PROTOCOL

See Also:

Constant Field Values

ACCESS_PATH

private static final java.lang.String ACCESS_PATH

See Also:

Constant Field Values

AUTHORIZE_PATH

private static final java.lang.String AUTHORIZE_PATH

See Also:

Constant Field Values

accessTokenUrl

private final java.lang.String accessTokenUrl

authorizationBaseUrl

private final java.lang.String authorizationBaseUrl

Constructor Detail

SalesforceApi

protected SalesforceApi(java.lang.String hostName)

Parameters:

hostName - The hostname to be used, which is either PRODUCTION_HOST or SANDBOX_HOST.

Method Detail

instance

public static SalesforceApi instance()

sandbox

public static SalesforceApi sandbox()

getAccessTokenVerb

public Verb getAccessTokenVerb()

Description copied from class: DefaultApi20

Returns the verb for the access token endpoint (defaults to POST)

Overrides:

getAccessTokenVerb in class DefaultApi20

Returns:

access token endpoint verb

getAccessTokenEndpoint

public java.lang.String getAccessTokenEndpoint()

Description copied from class: DefaultApi20

Returns the URL that receives the access token requests.

Specified by:

getAccessTokenEndpoint in class DefaultApi20

Returns:

access token URL

getAuthorizationBaseUrl

protected java.lang.String getAuthorizationBaseUrl()

Specified by:

getAuthorizationBaseUrl in class DefaultApi20

getAccessTokenExtractor

public TokenExtractor<OAuth2AccessToken> getAccessTokenExtractor()

Description copied from class: DefaultApi20

Returns the access token extractor.

Overrides:

getAccessTokenExtractor in class DefaultApi20

Returns:

access token extractor

isTLSv11orUpperEnabled

private static boolean isTLSv11orUpperEnabled(javax.net.ssl.SSLSocket socket)

initTLSv11orUpper

public static void initTLSv11orUpper()
                              throws java.security.NoSuchAlgorithmException,
                                     java.security.KeyManagementException,
                                     java.io.IOException

Salesforce API requires to use TLSv1.1 or upper.

Java 8 have TLS 1.2 enabled by default. java 7 - no, you should invoke this method or turn TLS>=1.1 somehow else

Throws:

java.security.NoSuchAlgorithmException - in case your jvm doesn't support TLSv1.1 or higher

java.security.KeyManagementException - unexpected Exception from SSLContext.init(javax.net.ssl.KeyManager[], javax.net.ssl.TrustManager[], java.security.SecureRandom)

java.io.IOException - unexpected Exception from SocketFactory.createSocket()

getClientAuthentication

public ClientAuthentication getClientAuthentication()

Overrides:

getClientAuthentication in class DefaultApi20