com.paypal.sdk

Class PaypalServerSdkClient

java.lang.Object

com.paypal.sdk.PaypalServerSdkClient

All Implemented Interfaces:

Configuration

public final class PaypalServerSdkClient
extends Object
implements Configuration

Gateway class for the library. This class acts as a factory for Controllers. It holds the state of the SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaypalServerSdkClient.Builder Class to build instances of PaypalServerSdkClient.

Method Summary

Modifier and Type	Method and Description
String	getBaseUri() Get base URI by current environment.
String	getBaseUri(Server server) Get base URI by current environment.
String	getBaseUri(String server) Get base URI by current environment.
ClientCredentialsAuth	getClientCredentialsAuth() The credentials to use with ClientCredentialsAuth.
ClientCredentialsAuthModel	getClientCredentialsAuthModel() The auth credential model for ClientCredentialsAuth.
Environment	getEnvironment() Current API environment.
ReadonlyHttpClientConfiguration	getHttpClientConfig() Http Client Configuration instance.
ReadonlyLoggingConfiguration	getLoggingConfig() Logging Configuration instance.
OAuthAuthorizationController	getOAuthAuthorizationController() Get the instance of OAuthAuthorizationController.
OrdersController	getOrdersController() Get the instance of OrdersController.
PaymentsController	getPaymentsController() Get the instance of PaymentsController.
SubscriptionsController	getSubscriptionsController() Get the instance of SubscriptionsController.
TransactionSearchController	getTransactionSearchController() Get the instance of TransactionSearchController.
VaultController	getVaultController() Get the instance of VaultController.
PaypalServerSdkClient.Builder	newBuilder() Builds a new PaypalServerSdkClient.Builder object.
static void	shutdown() Shutdown the underlying HttpClient instance.
long	timeout() Deprecated. This method will be removed in a future version. Use getHttpClientConfig() instead.
String	toString() Converts this PaypalServerSdkClient into string format.

Methods inherited from class java.lang.Object

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

Method Detail

shutdown

public static void shutdown()

Shutdown the underlying HttpClient instance.

getOrdersController

public OrdersController getOrdersController()

Get the instance of OrdersController.

Returns:

orders

getPaymentsController

public PaymentsController getPaymentsController()

Get the instance of PaymentsController.

Returns:

payments

getVaultController

public VaultController getVaultController()

Get the instance of VaultController.

Returns:

vault

getTransactionSearchController

public TransactionSearchController getTransactionSearchController()

Get the instance of TransactionSearchController.

Returns:

transactionSearch

getSubscriptionsController

public SubscriptionsController getSubscriptionsController()

Get the instance of SubscriptionsController.

Returns:

subscriptions

getOAuthAuthorizationController

public OAuthAuthorizationController getOAuthAuthorizationController()

Get the instance of OAuthAuthorizationController.

Returns:

oAuthAuthorization

getEnvironment

public Environment getEnvironment()

Current API environment.

Specified by:

getEnvironment in interface Configuration

Returns:

environment

getHttpClientConfig

public ReadonlyHttpClientConfiguration getHttpClientConfig()

Http Client Configuration instance.

Specified by:

getHttpClientConfig in interface Configuration

Returns:

httpClientConfig

getLoggingConfig

public ReadonlyLoggingConfiguration getLoggingConfig()

Logging Configuration instance.

Specified by:

getLoggingConfig in interface Configuration

Returns:

loggingConfig

getClientCredentialsAuth

public ClientCredentialsAuth getClientCredentialsAuth()

The credentials to use with ClientCredentialsAuth.

Specified by:

getClientCredentialsAuth in interface Configuration

Returns:

clientCredentialsAuth

getClientCredentialsAuthModel

public ClientCredentialsAuthModel getClientCredentialsAuthModel()

The auth credential model for ClientCredentialsAuth.

Specified by:

getClientCredentialsAuthModel in interface Configuration

Returns:

the instance of ClientCredentialsAuthModel

timeout

@Deprecated
public long timeout()

Deprecated. This method will be removed in a future version. Use getHttpClientConfig() instead.

The timeout to use for making HTTP requests.

Specified by:

timeout in interface Configuration

Returns:

timeout

getBaseUri

public String getBaseUri(Server server)

Get base URI by current environment.

Specified by:

getBaseUri in interface Configuration

Parameters:

server - Server for which to get the base URI

Returns:

Processed base URI

getBaseUri

public String getBaseUri()

Get base URI by current environment.

Specified by:

getBaseUri in interface Configuration

Returns:

Processed base URI

getBaseUri

public String getBaseUri(String server)

Get base URI by current environment.

Parameters:

server - string for which to get the base URI

Returns:

Processed base URI

toString

public String toString()

Converts this PaypalServerSdkClient into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

newBuilder

public PaypalServerSdkClient.Builder newBuilder()

Builds a new PaypalServerSdkClient.Builder object. Creates the instance with the state of the current client.

Returns:

a new PaypalServerSdkClient.Builder object