Package com.chargebee.v4.services

Class BaseService<T extends BaseService<T>>

java.lang.Object

com.chargebee.v4.services.BaseService<T>

Direct Known Subclasses:

AdditionalBillingLogiqService, AddonService, AddressService, AttachedItemService, BrandConfigurationService, BusinessEntityService, BusinessProfileService, CardService, CommentService, ConfigurationService, CouponCodeService, CouponService, CouponSetService, CreditNoteService, CsvTaxRuleService, CurrencyService, CustomerEntitlementService, CustomerService, DifferentialPriceService, EntitlementOverrideService, EntitlementService, EstimateService, EventService, ExportService, FeatureService, FullExportService, GiftService, HostedPageService, InAppSubscriptionService, InvoiceService, ItemEntitlementService, ItemFamilyService, ItemPriceService, ItemService, MediaService, NonSubscriptionService, OfferEventService, OfferFulfillmentService, OmnichannelOneTimeOrderService, OmnichannelSubscriptionItemService, OmnichannelSubscriptionService, OrderService, PaymentIntentService, PaymentScheduleSchemeService, PaymentSourceService, PaymentVoucherService, Pc2MigrationItemFamilyService, Pc2MigrationItemPriceService, Pc2MigrationItemService, Pc2MigrationService, PersonalizedOfferService, PlanService, PortalSessionService, PriceVariantService, PricingPageSessionService, ProductService, PromotionalCreditService, PurchaseService, QuoteService, RampService, RecordedPurchaseService, ResourceMigrationService, RuleService, SiteMigrationDetailService, SubscriptionEntitlementService, SubscriptionService, SubscriptionSettingService, ThirdPartyConfigurationService, ThirdPartyEntityMappingService, ThirdPartySyncDetailService, TimeMachineService, TpSiteUserService, TransactionService, UnbilledChargeService, UnbilledChargesSettingService, UsageEventService, UsageFileService, UsageService, VariantService, VirtualBankAccountService, WebhookEndpointService

public abstract class BaseService<T extends BaseService<T>>
extends Object

Base class for all Chargebee resource services. Provides common functionality and per-request options support.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ChargebeeClient	client
protected final RequestOptions	options

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseService(ChargebeeClient client)
protected	BaseService(ChargebeeClient client, RequestOptions options)

Method Summary

Modifier and Type	Method	Description
protected String	buildPathWithParams(String pathTemplate, String paramName, String paramValue)	Build path with path parameters replaced.
protected Object	clientForBuilders()	Helper: Client instance appropriate for builders.
protected ChargebeeClient	clientWithOptions()	Get a client instance with merged headers (client + request options).
protected Response	get(String path, Map<String,Object> queryParams)	GET with Object query parameters.
protected CompletableFuture<Response>	getAsync(String path, Map<String,Object> queryParams)	GET async with Object query parameters.
protected Map<String,String>	getMergedHeaders()	Get the merged headers for this request.
T	header(String key, String value)
T	headers(Map<String,String> headers)
T	options(RequestOptions explicitOptions)	Alias for withOptions for natural readability.
protected <R> R	parseResponse(Response response, Class<R> responseClass)	Parse response into response object using fromJson method.
protected Response	post(String path, Map<String,Object> formData)	Helper: POST with optional headers.
protected CompletableFuture<Response>	postAsync(String path, Map<String,Object> formData)	Helper: POST async with optional headers.
protected Response	postJson(String path, String jsonData)	Helper: POST JSON with optional headers.
protected CompletableFuture<Response>	postJsonAsync(String path, String jsonData)	Helper: POST JSON async with optional headers.
T	withOptions(RequestOptions explicitOptions)	Apply explicit RequestOptions for subsequent calls on this service instance.

Methods inherited from class java.lang.Object

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

Field Details

client

protected final ChargebeeClient client

options

protected final RequestOptions options

Constructor Details

BaseService

protected BaseService(ChargebeeClient client)

BaseService

protected BaseService(ChargebeeClient client,
 RequestOptions options)

Method Details

withOptions

public T withOptions(RequestOptions explicitOptions)

Apply explicit RequestOptions for subsequent calls on this service instance.

options

public T options(RequestOptions explicitOptions)

Alias for withOptions for natural readability.

header

public T header(String key,
 String value)

headers

public T headers(Map<String,String> headers)

clientWithOptions

protected ChargebeeClient clientWithOptions()

Get a client instance with merged headers (client + request options).

getMergedHeaders

protected Map<String,String> getMergedHeaders()

Get the merged headers for this request.

clientForBuilders

protected Object clientForBuilders()

Helper: Client instance appropriate for builders. Returns the original client if no headers, otherwise a headered client.

post

protected Response post(String path,
 Map<String,Object> formData)
                 throws ChargebeeException

Helper: POST with optional headers.

Throws:

ChargebeeException

postJson

protected Response postJson(String path,
 String jsonData)
                     throws ChargebeeException

Helper: POST JSON with optional headers.

Throws:

ChargebeeException

postAsync

protected CompletableFuture<Response> postAsync(String path,
 Map<String,Object> formData)

Helper: POST async with optional headers.

postJsonAsync

protected CompletableFuture<Response> postJsonAsync(String path,
 String jsonData)

Helper: POST JSON async with optional headers.

buildPathWithParams

protected String buildPathWithParams(String pathTemplate,
 String paramName,
 String paramValue)

Build path with path parameters replaced.

parseResponse

protected <R> R parseResponse(Response response,
 Class<R> responseClass)

Parse response into response object using fromJson method. This follows the same pattern as model classes.

get

protected Response get(String path,
 Map<String,Object> queryParams)
                throws ChargebeeException

GET with Object query parameters.

Throws:

ChargebeeException

getAsync

protected CompletableFuture<Response> getAsync(String path,
 Map<String,Object> queryParams)

GET async with Object query parameters.