com.paypal.base.rest

Class PayPalResource

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

Direct Known Subclasses:

Agreement, Authorization, Capture, CreditCard, Event, EventType, Invoice, Order, Payment, PaymentInstruction, Payout, PayoutItem, Plan, Refund, Sale, Template, Templates, Tokeninfo, Userinfo, Webhook, WebhookList, WebProfile

public abstract class PayPalResource
extends PayPalModel

PayPalResource acts as a base class for REST enabled resources.

Constructor Summary

Constructors

Constructor and Description
PayPalResource()

Method Summary

Modifier and Type	Method and Description
static <T> T	configureAndExecute(APIContext apiContext, HttpMethod httpMethod, java.lang.String resourcePath, java.util.Map<java.lang.String,java.lang.String> headersMap, java.lang.String payLoad, java.lang.Class<T> clazz) Deprecated. Please use configureAndExecute(APIContext, HttpMethod, String, String, Class) instead. Headers could be passed directly to #APIContext itself.
static <T> T	configureAndExecute(APIContext apiContext, HttpMethod httpMethod, java.lang.String resourcePath, java.lang.String payLoad, java.lang.Class<T> clazz) Configures and executes REST call
static <T> T	configureAndExecute(APIContext apiContext, HttpMethod httpMethod, java.lang.String resourcePath, java.lang.String payLoad, java.lang.Class<T> clazz, java.lang.String accessToken) Configures and executes REST call: Supports JSON
static <T> T	configureAndExecute(java.lang.String accessToken, HttpMethod httpMethod, java.lang.String resourcePath, java.lang.String payLoad, java.lang.Class<T> clazz) Deprecated. Please use configureAndExecute(APIContext, HttpMethod, String, String, Class) instead. Passing APIContext gives us better information than just raw access token.
static APICallPreHandler	createAPICallPreHandler(java.util.Map<java.lang.String,java.lang.String> configurationMap, java.lang.String payLoad, java.lang.String resourcePath, java.util.Map<java.lang.String,java.lang.String> headersMap, java.lang.String accessToken, java.lang.String requestId, SDKVersion sdkVersion) Returns a implementation of APICallPreHandler for the underlying layer.
ClientCredentials	getClientCredential() Deprecated. Please use static method `getCredential` instead. Returns ClientCredentials with client id and client secret from configuration Map.
static java.lang.String	getClientID() Return Client ID from configuration Map
static java.lang.String	getClientSecret() Returns Client Secret from configuration Map
static java.util.Map<java.lang.String,java.lang.String>	getConfigurations()
static ClientCredentials	getCredential() Returns ClientCredentials with client id and client secret from configuration Map
static java.lang.String	getLastRequest() Returns the last request sent to the Service
static java.lang.String	getLastResponse() Returns the last response returned by the Service
static OAuthTokenCredential	getOAuthTokenCredential() Returns OAuthTokenCredential instance using client ID and client secret loaded from configuration.
static OAuthTokenCredential	initConfig(java.io.File file) Initialize the system using a File(Properties file).
static OAuthTokenCredential	initConfig(java.io.InputStream inputStream) Initialize using InputStream(of a Properties file)..
static OAuthTokenCredential	initConfig(java.util.Properties properties) Initialize using Properties.
static void	initializeToDefault() Initialize to default properties

Methods inherited from class com.paypal.base.rest.PayPalModel

canEqual, equals, hashCode, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PayPalResource

public PayPalResource()

Method Detail

initConfig

public static OAuthTokenCredential initConfig(java.io.File file)
                                       throws PayPalRESTException

Initialize the system using a File(Properties file). The system is initialized using the given file and if the initialization succeeds the default 'sdk_config.properties' can only be loaded by calling the method initializeToDefault()

Parameters:

file - File object of a properties entity

Returns:

OAuthTokenCredential instance with client ID and client secret stored in configuration file.

Throws:

PayPalRESTException

initConfig

public static OAuthTokenCredential initConfig(java.util.Properties properties)

Initialize using Properties. The system is initialized using the given properties object and if the initialization succeeds the default 'sdk_config.properties' can only be loaded by calling the method initializeToDefault()

Parameters:

properties - Properties object

Returns:

OAuthTokenCredential instance with client ID and client secret in given properties.

initConfig

public static OAuthTokenCredential initConfig(java.io.InputStream inputStream)
                                       throws PayPalRESTException

Initialize using InputStream(of a Properties file).. The system is initialized using the given InputStream and if the initialization succeeds the default 'sdk_config.properties' can only be loaded by calling the method initializeToDefault(). The system is initialized with the information after loading defaults for the parameters that are not passed as part of the configuration. For defaults see ConfigManager

Parameters:

inputStream - InputStream

Returns:

OAuthTokenCredential instance with client ID and client secret stored in given inputStream.

Throws:

PayPalRESTException

getClientID

public static java.lang.String getClientID()

Return Client ID from configuration Map

getClientSecret

public static java.lang.String getClientSecret()

Returns Client Secret from configuration Map

getOAuthTokenCredential

public static OAuthTokenCredential getOAuthTokenCredential()

Returns OAuthTokenCredential instance using client ID and client secret loaded from configuration.

Returns:

OAuthTokenCredential instance.

initializeToDefault

public static void initializeToDefault()
                                throws PayPalRESTException

Initialize to default properties

Throws:

PayPalRESTException

getLastRequest

public static java.lang.String getLastRequest()

Returns the last request sent to the Service

Returns:

Last request sent to the server

getLastResponse

public static java.lang.String getLastResponse()

Returns the last response returned by the Service

Returns:

Last response got from the Service

getConfigurations

public static java.util.Map<java.lang.String,java.lang.String> getConfigurations()

configureAndExecute

public static <T> T configureAndExecute(java.lang.String accessToken,
                                        HttpMethod httpMethod,
                                        java.lang.String resourcePath,
                                        java.lang.String payLoad,
                                        java.lang.Class<T> clazz)
                                 throws PayPalRESTException

Deprecated. Please use configureAndExecute(APIContext, HttpMethod, String, String, Class) instead. Passing APIContext gives us better information than just raw access token.

Configures and executes REST call: Supports JSON

Type Parameters:

T - Response Type for de-serialization

Parameters:

accessToken - OAuth AccessToken to be used for the call.

httpMethod - Http Method verb

resourcePath - Resource URI path

payLoad - Payload to Service

clazz - Class object used in De-serialization

Returns:

T

Throws:

PayPalRESTException

configureAndExecute

public static <T> T configureAndExecute(APIContext apiContext,
                                        HttpMethod httpMethod,
                                        java.lang.String resourcePath,
                                        java.lang.String payLoad,
                                        java.lang.Class<T> clazz)
                                 throws PayPalRESTException

Configures and executes REST call

Type Parameters:

T - Response Type for de-serialization

Parameters:

apiContext - APIContext to be used for the call.

httpMethod - Http Method verb

resourcePath - Resource URI path

payLoad - Payload to Service

clazz - Class object used in De-serialization

Returns:

T

Throws:

PayPalRESTException

configureAndExecute

public static <T> T configureAndExecute(APIContext apiContext,
                                        HttpMethod httpMethod,
                                        java.lang.String resourcePath,
                                        java.lang.String payLoad,
                                        java.lang.Class<T> clazz,
                                        java.lang.String accessToken)
                                 throws PayPalRESTException

Configures and executes REST call: Supports JSON

Type Parameters:

T - Response Type for de-serialization

Parameters:

apiContext - APIContext to be used for the call.

httpMethod - Http Method verb

resourcePath - Resource URI path

payLoad - Payload to Service

clazz - Class object used in De-serialization

accessToken - Access Token to be used instead of apiContext

Returns:

T

Throws:

PayPalRESTException

configureAndExecute

public static <T> T configureAndExecute(APIContext apiContext,
                                        HttpMethod httpMethod,
                                        java.lang.String resourcePath,
                                        java.util.Map<java.lang.String,java.lang.String> headersMap,
                                        java.lang.String payLoad,
                                        java.lang.Class<T> clazz)
                                 throws PayPalRESTException

Deprecated. Please use configureAndExecute(APIContext, HttpMethod, String, String, Class) instead. Headers could be passed directly to #APIContext itself.

Configures and executes REST call: Supports JSON

Type Parameters:

T -

Parameters:

apiContext - APIContext to be used for the call.

httpMethod - Http Method verb

resourcePath - Resource URI path

headersMap - Optional headers Map

payLoad - Payload to Service

clazz - Class object used in De-serialization

Returns:

T

Throws:

PayPalRESTException

createAPICallPreHandler

public static APICallPreHandler createAPICallPreHandler(java.util.Map<java.lang.String,java.lang.String> configurationMap,
                                                        java.lang.String payLoad,
                                                        java.lang.String resourcePath,
                                                        java.util.Map<java.lang.String,java.lang.String> headersMap,
                                                        java.lang.String accessToken,
                                                        java.lang.String requestId,
                                                        SDKVersion sdkVersion)

Returns a implementation of APICallPreHandler for the underlying layer.

Parameters:

configurationMap - configuration Map

payLoad - Raw payload

resourcePath - URI part of the resource operated on

headersMap - Custom HTTP headers map

accessToken - OAuth Token

requestId - PayPal Request Id

sdkVersion - SDKVersion instance

Returns:

APICallPreHandler

getCredential

public static ClientCredentials getCredential()

Returns ClientCredentials with client id and client secret from configuration Map

Returns:

Client credentials

getClientCredential

public ClientCredentials getClientCredential()

Deprecated. Please use static method `getCredential` instead. Returns ClientCredentials with client id and client secret from configuration Map.

Returns:

Client credentials