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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAccessTokenEndpoint()
TokenExtractor<OAuth2AccessToken>	getAccessTokenExtractor()
Verb	getAccessTokenVerb()
protected java.lang.String	getAuthorizationBaseUrl()
ClientAuthentication	getClientAuthentication()
static void	initTLSv11orUpper()	Salesforce API requires to use TLSv1.1 or upper.
static SalesforceApi	instance()
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

Constructor Details

SalesforceApi

protected SalesforceApi(java.lang.String hostName)

Parameters:

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

Method Details

instance

public static SalesforceApi instance()

sandbox

public static SalesforceApi sandbox()

getAccessTokenVerb

public Verb getAccessTokenVerb()

Overrides:

getAccessTokenVerb in class DefaultApi20

getAccessTokenEndpoint

public java.lang.String getAccessTokenEndpoint()

Specified by:

getAccessTokenEndpoint in class DefaultApi20

getAuthorizationBaseUrl

protected java.lang.String getAuthorizationBaseUrl()

Specified by:

getAuthorizationBaseUrl in class DefaultApi20

getAccessTokenExtractor

public TokenExtractor<OAuth2AccessToken> getAccessTokenExtractor()

Overrides:

getAccessTokenExtractor in class DefaultApi20

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