org.killbill.billing.jaxrs.resources

Class JaxRsResourceBase

java.lang.Object

org.killbill.billing.jaxrs.resources.JaxRsResourceBase

All Implemented Interfaces:

JaxrsResource

Direct Known Subclasses:

AccountResource, AdminResource, BundleResource, CatalogResource, ComboPaymentResource, CreditResource, CustomFieldResource, ExportResource, InvoicePaymentResource, InvoiceResource, NodesInfoResource, OverdueResource, PaymentMethodResource, PluginInfoResource, PluginResource, SecurityResource, SubscriptionResource, TagDefinitionResource, TagResource, TenantResource, TestResource, TransactionResource, UsageResource

public abstract class JaxRsResourceBase
extends Object
implements JaxrsResource

Field Summary

Fields

Modifier and Type	Field and Description
protected AccountUserApi	accountUserApi
protected org.killbill.billing.util.api.AuditUserApi	auditUserApi
protected static String	catalogName
protected org.killbill.clock.Clock	clock
protected Context	context
protected org.killbill.billing.util.api.CustomFieldUserApi	customFieldUserApi
protected org.joda.time.format.DateTimeFormatter	DATE_TIME_FORMATTER
protected org.joda.time.format.DateTimeFormatter	LOCAL_DATE_FORMATTER
protected static ObjectMapper	mapper
protected PaymentApi	paymentApi
protected SubscriptionApi	subscriptionApi
protected org.killbill.billing.util.api.TagUserApi	tagUserApi
protected JaxrsUriBuilder	uriBuilder

Fields inherited from interface org.killbill.billing.jaxrs.resources.JaxrsResource

ACCOUNTS, ACCOUNTS_PATH, ADMIN, ADMIN_PATH, ALL_TAGS, ANALYTICS, ANALYTICS_PATH, ANYTHING_PATTERN, API_POSTFIX, API_PREFIX, API_VERSION, AUTHORIZATION, BCD, BLOCK, BUNDLES, BUNDLES_PATH, CACHE, CANCEL_SCHEDULED_PAYMENT_TRANSACTION, CAPTURE, CATALOG, CATALOG_PATH, CBA_REBALANCING, CHARGEBACK_REVERSALS, CHARGEBACK_REVERSALS_PATH, CHARGEBACKS, CHARGEBACKS_PATH, CHARGES, CHARGES_PATH, CHILDREN, COMBO, COMMIT_INVOICE, CREDITS, CREDITS_PATH, CUSTOM_FIELDS, CUSTOM_FIELDS_PATH, DRY_RUN, EMAIL_NOTIFICATIONS, EMAILS, ENTITLEMENTS, ENTITLEMENTS_PATH, EXPORT, EXPORT_PATH, FORM, HDR_API_KEY, HDR_API_SECRET, HDR_COMMENT, HDR_CREATED_BY, HDR_PAGINATION_CURRENT_OFFSET, HDR_PAGINATION_MAX_NB_RECORDS, HDR_PAGINATION_NEXT_OFFSET, HDR_PAGINATION_NEXT_PAGE_URI, HDR_PAGINATION_TOTAL_NB_RECORDS, HDR_REASON, HOSTED, INVOICE_CATALOG_TRANSLATION, INVOICE_MP_TEMPLATE, INVOICE_PAYMENTS, INVOICE_PAYMENTS_PATH, INVOICE_TEMPLATE, INVOICE_TRANSLATION, INVOICES, INVOICES_PATH, MIGRATION, NODES_INFO, NODES_INFO_PATH, NOTIFICATION, NUMBER_PATTERN, OVERDUE, OVERDUE_PATH, PAGINATION, PAUSE, PAYMENT_GATEWAYS, PAYMENT_GATEWAYS_PATH, PAYMENT_METHODS, PAYMENT_METHODS_DEFAULT_PATH_POSTFIX, PAYMENT_METHODS_PATH, PAYMENT_TRANSACTIONS, PAYMENT_TRANSACTIONS_PATH, PAYMENTS, PAYMENTS_PATH, PLUGIN_CONFIG, PLUGINS, PLUGINS_INFO, PLUGINS_INFO_PATH, PLUGINS_PATH, PREFIX, QUERY_ACCOUNT_ID, QUERY_ACCOUNT_WITH_BALANCE, QUERY_ACCOUNT_WITH_BALANCE_AND_CBA, QUERY_API_KEY, QUERY_AUDIT, QUERY_AUTO_COMMIT, QUERY_BCD, QUERY_BILLING_POLICY, QUERY_BILLING_REQUESTED_DT, QUERY_BLOCKING_STATE_SVCS, QUERY_BLOCKING_STATE_TYPES, QUERY_BUNDLE_TRANSFER_ADDON, QUERY_BUNDLE_TRANSFER_CANCEL_IMM, QUERY_BUNDLES_FILTER, QUERY_CALL_COMPLETION, QUERY_CALL_TIMEOUT, QUERY_CUSTOM_FIELDS, QUERY_DELETE_DEFAULT_PM_WITH_AUTO_PAY_OFF, QUERY_DELETE_IF_EXISTS, QUERY_END_DATE, QUERY_ENTITLEMENT_EFFECTIVE_FROM_DT, QUERY_ENTITLEMENT_POLICY, QUERY_ENTITLEMENT_REQUESTED_DT, QUERY_EXTERNAL_KEY, QUERY_FORCE_DEFAULT_PM_DELETION, QUERY_INCLUDED_DELETED, QUERY_INVOICE_WITH_CHILDREN_ITEMS, QUERY_INVOICE_WITH_ITEMS, QUERY_LOCAL_NODE_ONLY, QUERY_MIGRATED, QUERY_NOTIFICATION_CALLBACK, QUERY_OBJECT_TYPE, QUERY_PARALLEL, QUERY_PAY_ALL_UNPAID_INVOICES, QUERY_PAY_INVOICE, QUERY_PAYMENT_AMOUNT, QUERY_PAYMENT_CONTROL_PLUGIN_NAME, QUERY_PAYMENT_EXTERNAL, QUERY_PAYMENT_EXTERNAL_KEY, QUERY_PAYMENT_METHOD_ID, QUERY_PAYMENT_METHOD_IS_DEFAULT, QUERY_PAYMENT_METHOD_PLUGIN_NAME, QUERY_PAYMENT_PLUGIN_NAME, QUERY_PAYMENT_WITH_REFUNDS_AND_CHARGEBACKS, QUERY_PLUGIN_PROPERTY, QUERY_REQUESTED_DT, QUERY_SEARCH_LIMIT, QUERY_SEARCH_OFFSET, QUERY_START_DATE, QUERY_TAGS, QUERY_TAGS_INCLUDED_DELETED, QUERY_TARGET_DATE, QUERY_TENANT_USE_GLOBAL_DEFAULT, QUERY_TRANSACTION_EXTERNAL_KEY, QUERY_UNPAID_INVOICES_ONLY, QUERY_USE_REQUESTED_DATE_FOR_BILLING, QUERY_WITH_ATTEMPTS, QUERY_WITH_MIGRATION_INVOICES, QUERY_WITH_PLUGIN_INFO, REFUNDS, REGISTER_NOTIFICATION_CALLBACK, RESUME, SEARCH, SECURITY, SECURITY_PATH, STRING_PATTERN, SUBSCRIPTIONS, SUBSCRIPTIONS_PATH, TAG_DEFINITIONS, TAG_DEFINITIONS_PATH, TAGS, TAGS_PATH, TENANTS, TENANTS_PATH, TEST, TEST_PATH, TIMELINE, TRANSFER_CREDIT, UPLOAD_PER_TENANT_CONFIG, UPLOAD_PLUGIN_CONFIG, UPLOAD_PLUGIN_PAYMENT_STATE_MACHINE_CONFIG, USAGES, USAGES_PATH, USER_KEY_VALUE, UUID_PATTERN

Constructor Summary

Constructors

Constructor and Description
JaxRsResourceBase(JaxrsUriBuilder uriBuilder, org.killbill.billing.util.api.TagUserApi tagUserApi, org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi, org.killbill.billing.util.api.AuditUserApi auditUserApi, AccountUserApi accountUserApi, PaymentApi paymentApi, SubscriptionApi subscriptionApi, org.killbill.clock.Clock clock, Context context)

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addBlockingState(BlockingStateJson json, String id, BlockingStateType type, String requestedDate, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
protected <E extends Entity,J extends JsonBase> javax.ws.rs.core.Response	buildStreamingPaginationResponse(Pagination<E> entities, com.google.common.base.Function<E,J> toJson, URI nextPageUri)
protected PaymentOptions	createControlPluginApiPaymentOptions(boolean isExternalPayment, List<String> paymentControlPluginNames)
protected PaymentOptions	createControlPluginApiPaymentOptions(List<String> paymentControlPluginNames)
protected javax.ws.rs.core.Response	createCustomFields(UUID id, List<CustomFieldJson> customFields, CallContext context, javax.ws.rs.core.UriInfo uriInfo)
protected PaymentOptions	createInvoicePaymentControlPluginApiPaymentOptions(boolean isExternalPayment)
protected javax.ws.rs.core.Response	createPaymentResponse(javax.ws.rs.core.UriInfo uriInfo, Payment payment, TransactionType transactionType, String transactionExternalKey)
protected Payment	createPurchaseForInvoice(Account account, UUID invoiceId, BigDecimal amountToPay, UUID paymentMethodId, Boolean externalPayment, String paymentExternalKey, String transactionExternalKey, Iterable<PluginProperty> pluginProperties, CallContext callContext)
protected javax.ws.rs.core.Response	createTagResponse(UUID accountId, List<Tag> tags, AuditMode auditMode, TenantContext context)
protected javax.ws.rs.core.Response	createTags(UUID id, String tagList, javax.ws.rs.core.UriInfo uriInfo, CallContext context)
protected javax.ws.rs.core.Response	deleteCustomFields(UUID id, String customFieldList, CallContext context)
protected javax.ws.rs.core.Response	deleteTags(UUID id, String tagList, CallContext context)
protected Iterable<PluginProperty>	extractPluginProperties(Iterable<PluginPropertyJson> pluginProperties)
protected Iterable<PluginProperty>	extractPluginProperties(Iterable<String> pluginProperties, PluginProperty... additionalProperties)
protected javax.ws.rs.core.Response	getCustomFields(UUID id, AuditMode auditMode, TenantContext context)
static UUID	getInvoiceId(List<InvoicePayment> invoicePayments, Payment payment)
protected org.killbill.billing.ObjectType	getObjectType()
static Iterable<PaymentTransaction>	getPaymentTransactions(List<Payment> payments, TransactionType transactionType)
protected Collection<UUID>	getTagDefinitionUUIDs(String tagList)
protected javax.ws.rs.core.Response	getTags(UUID accountId, UUID taggedObjectId, AuditMode auditMode, boolean includeDeleted, TenantContext context)
protected void	logDeprecationParameterWarningIfNeeded(String deprecatedParam, String... replacementParams)
protected PaymentTransaction	lookupPendingOrSuccessTransaction(Payment initialPayment, String transactionId, String transactionExternalKey, String transactionType)
protected org.joda.time.LocalDate	toLocalDate(String inputDate)
protected org.joda.time.LocalDate	toLocalDateDefaultToday(Account account, String inputDate, TenantContext context)
protected org.joda.time.LocalDate	toLocalDateDefaultToday(UUID accountId, String inputDate, TenantContext context)
protected void	validatePaymentMethodForAccount(UUID accountId, UUID paymentMethodId, CallContext callContext)
protected void	verifyNonNull(Object... elements)
protected void	verifyNonNullOrEmpty(Object... elements)
protected void	verifyNumberOfElements(int actual, int expected, String errorMessage)

Methods inherited from class java.lang.Object

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

Field Detail

catalogName

protected static final String catalogName

See Also:

Constant Field Values

mapper

protected static final ObjectMapper mapper

uriBuilder

protected final JaxrsUriBuilder uriBuilder

tagUserApi

protected final org.killbill.billing.util.api.TagUserApi tagUserApi

customFieldUserApi

protected final org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi

auditUserApi

protected final org.killbill.billing.util.api.AuditUserApi auditUserApi

accountUserApi

protected final AccountUserApi accountUserApi

paymentApi

protected final PaymentApi paymentApi

subscriptionApi

protected final SubscriptionApi subscriptionApi

context

protected final Context context

clock

protected final org.killbill.clock.Clock clock

DATE_TIME_FORMATTER

protected final org.joda.time.format.DateTimeFormatter DATE_TIME_FORMATTER

LOCAL_DATE_FORMATTER

protected final org.joda.time.format.DateTimeFormatter LOCAL_DATE_FORMATTER

Constructor Detail

JaxRsResourceBase

public JaxRsResourceBase(JaxrsUriBuilder uriBuilder,
                 org.killbill.billing.util.api.TagUserApi tagUserApi,
                 org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi,
                 org.killbill.billing.util.api.AuditUserApi auditUserApi,
                 AccountUserApi accountUserApi,
                 PaymentApi paymentApi,
                 SubscriptionApi subscriptionApi,
                 org.killbill.clock.Clock clock,
                 Context context)

Method Detail

getObjectType

protected org.killbill.billing.ObjectType getObjectType()

addBlockingState

public javax.ws.rs.core.Response addBlockingState(BlockingStateJson json,
                                         String id,
                                         BlockingStateType type,
                                         String requestedDate,
                                         List<String> pluginPropertiesString,
                                         String createdBy,
                                         String reason,
                                         String comment,
                                         javax.servlet.http.HttpServletRequest request)
                                           throws SubscriptionApiException,
                                                  EntitlementApiException,
                                                  AccountApiException

Throws:

SubscriptionApiException

EntitlementApiException

AccountApiException

getTags

protected javax.ws.rs.core.Response getTags(UUID accountId,
                                UUID taggedObjectId,
                                AuditMode auditMode,
                                boolean includeDeleted,
                                TenantContext context)
                                     throws org.killbill.billing.util.api.TagDefinitionApiException

Throws:

org.killbill.billing.util.api.TagDefinitionApiException

createTagResponse

protected javax.ws.rs.core.Response createTagResponse(UUID accountId,
                                          List<Tag> tags,
                                          AuditMode auditMode,
                                          TenantContext context)
                                               throws org.killbill.billing.util.api.TagDefinitionApiException

Throws:

org.killbill.billing.util.api.TagDefinitionApiException

createTags

protected javax.ws.rs.core.Response createTags(UUID id,
                                   String tagList,
                                   javax.ws.rs.core.UriInfo uriInfo,
                                   CallContext context)
                                        throws org.killbill.billing.util.api.TagApiException

Throws:

org.killbill.billing.util.api.TagApiException

getTagDefinitionUUIDs

protected Collection<UUID> getTagDefinitionUUIDs(String tagList)

deleteTags

protected javax.ws.rs.core.Response deleteTags(UUID id,
                                   String tagList,
                                   CallContext context)
                                        throws org.killbill.billing.util.api.TagApiException

Throws:

org.killbill.billing.util.api.TagApiException

getCustomFields

protected javax.ws.rs.core.Response getCustomFields(UUID id,
                                        AuditMode auditMode,
                                        TenantContext context)

createCustomFields

protected javax.ws.rs.core.Response createCustomFields(UUID id,
                                           List<CustomFieldJson> customFields,
                                           CallContext context,
                                           javax.ws.rs.core.UriInfo uriInfo)
                                                throws org.killbill.billing.util.api.CustomFieldApiException

Throws:

org.killbill.billing.util.api.CustomFieldApiException

deleteCustomFields

protected javax.ws.rs.core.Response deleteCustomFields(UUID id,
                                           @Nullable
                                           String customFieldList,
                                           CallContext context)
                                                throws org.killbill.billing.util.api.CustomFieldApiException

Parameters:

id - the if of the object for which the custom fields apply

customFieldList - a comma separated list of custom field ids or null if they should all be removed

context - the context

Returns:

Throws:

org.killbill.billing.util.api.CustomFieldApiException

buildStreamingPaginationResponse

protected <E extends Entity,J extends JsonBase> javax.ws.rs.core.Response buildStreamingPaginationResponse(Pagination<E> entities,
                                                                                               com.google.common.base.Function<E,J> toJson,
                                                                                               URI nextPageUri)

validatePaymentMethodForAccount

protected void validatePaymentMethodForAccount(UUID accountId,
                                   UUID paymentMethodId,
                                   CallContext callContext)
                                        throws PaymentApiException

Throws:

PaymentApiException

lookupPendingOrSuccessTransaction

protected PaymentTransaction lookupPendingOrSuccessTransaction(Payment initialPayment,
                                                   @Nullable
                                                   String transactionId,
                                                   @Nullable
                                                   String transactionExternalKey,
                                                   @Nullable
                                                   String transactionType)
                                                        throws PaymentApiException

Throws:

PaymentApiException

toLocalDateDefaultToday

protected org.joda.time.LocalDate toLocalDateDefaultToday(UUID accountId,
                                              @Nullable
                                              String inputDate,
                                              TenantContext context)
                                                   throws AccountApiException

Throws:

AccountApiException

toLocalDateDefaultToday

protected org.joda.time.LocalDate toLocalDateDefaultToday(Account account,
                                              @Nullable
                                              String inputDate,
                                              TenantContext context)

toLocalDate

protected org.joda.time.LocalDate toLocalDate(@Nullable
                                  String inputDate)

extractPluginProperties

protected Iterable<PluginProperty> extractPluginProperties(@Nullable
                                               Iterable<PluginPropertyJson> pluginProperties)

extractPluginProperties

protected Iterable<PluginProperty> extractPluginProperties(@Nullable
                                               Iterable<String> pluginProperties,
                                               PluginProperty... additionalProperties)

createPurchaseForInvoice

protected Payment createPurchaseForInvoice(Account account,
                               UUID invoiceId,
                               BigDecimal amountToPay,
                               UUID paymentMethodId,
                               Boolean externalPayment,
                               String paymentExternalKey,
                               String transactionExternalKey,
                               Iterable<PluginProperty> pluginProperties,
                               CallContext callContext)
                                    throws PaymentApiException

Throws:

PaymentApiException

createInvoicePaymentControlPluginApiPaymentOptions

protected PaymentOptions createInvoicePaymentControlPluginApiPaymentOptions(boolean isExternalPayment)

createControlPluginApiPaymentOptions

protected PaymentOptions createControlPluginApiPaymentOptions(@Nullable
                                                  List<String> paymentControlPluginNames)

createControlPluginApiPaymentOptions

protected PaymentOptions createControlPluginApiPaymentOptions(boolean isExternalPayment,
                                                  List<String> paymentControlPluginNames)

getPaymentTransactions

public static Iterable<PaymentTransaction> getPaymentTransactions(List<Payment> payments,
                                                  TransactionType transactionType)

getInvoiceId

public static UUID getInvoiceId(List<InvoicePayment> invoicePayments,
                Payment payment)

verifyNonNullOrEmpty

protected void verifyNonNullOrEmpty(Object... elements)

verifyNonNull

protected void verifyNonNull(Object... elements)

verifyNumberOfElements

protected void verifyNumberOfElements(int actual,
                          int expected,
                          String errorMessage)

logDeprecationParameterWarningIfNeeded

protected void logDeprecationParameterWarningIfNeeded(@Nullable
                                          String deprecatedParam,
                                          String... replacementParams)

createPaymentResponse

protected javax.ws.rs.core.Response createPaymentResponse(javax.ws.rs.core.UriInfo uriInfo,
                                              Payment payment,
                                              TransactionType transactionType,
                                              @Nullable
                                              String transactionExternalKey)