org.killbill.billing.jaxrs.resources

Class SubscriptionResource

java.lang.Object

org.killbill.billing.jaxrs.resources.JaxRsResourceBase

org.killbill.billing.jaxrs.resources.SubscriptionResource

All Implemented Interfaces:

JaxrsResource

public class SubscriptionResource
extends JaxRsResourceBase

Field Summary

Fields inherited from class org.killbill.billing.jaxrs.resources.JaxRsResourceBase

accountUserApi, auditUserApi, clock, context, customFieldUserApi, DATE_TIME_FORMATTER, LOCAL_DATE_FORMATTER, mapper, paymentApi, tagUserApi, 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, BUNDLES, BUNDLES_PATH, CAPTURE, CATALOG, CATALOG_PATH, CBA_REBALANCING, CHARGEBACKS, CHARGEBACKS_PATH, CHARGES, CHARGES_PATH, COMBO, 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, 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, PLUGINS, PLUGINS_PATH, PREFIX, QUERY_ACCOUNT_ID, QUERY_ACCOUNT_WITH_BALANCE, QUERY_ACCOUNT_WITH_BALANCE_AND_CBA, QUERY_API_KEY, QUERY_AUDIT, QUERY_BILLING_POLICY, QUERY_BUNDLE_TRANSFER_ADDON, QUERY_BUNDLE_TRANSFER_CANCEL_IMM, 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_POLICY, QUERY_EXTERNAL_KEY, QUERY_INVOICE_WITH_ITEMS, 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_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_UNPAID_INVOICES_ONLY, QUERY_USE_REQUESTED_DATE_FOR_BILLING, 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, UPLOAD_PLUGIN_CONFIG, USAGES, USAGES_PATH, USER_KEY_VALUE, UUID_PATTERN

Constructor Summary

Constructors

Constructor and Description

SubscriptionResource(KillbillEventHandler killbillHandler, JaxrsUriBuilder uriBuilder, org.killbill.billing.util.api.TagUserApi tagUserApi, org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi, org.killbill.billing.util.api.AuditUserApi auditUserApi, EntitlementApi entitlementApi, SubscriptionApi subscriptionApi, AccountUserApi accountUserApi, PaymentApi paymentApi, org.killbill.clock.Clock clock, Context context)

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	cancelEntitlementPlan(String subscriptionId, String requestedDate, Boolean callCompletion, long timeoutSec, String entitlementPolicyString, String billingPolicyString, Boolean useRequestedDateForBilling, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	changeEntitlementPlan(SubscriptionJson entitlement, String subscriptionId, String requestedDate, Boolean callCompletion, long timeoutSec, String policyString, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	createCustomFields(String id, List<CustomFieldJson> customFields, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	createEntitlement(SubscriptionJson entitlement, String requestedDate, Boolean callCompletion, long timeoutSec, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	createTags(String id, String tagList, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deleteCustomFields(String id, String customFieldList, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deleteTags(String id, String tagList, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getCustomFields(String id, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getEntitlement(String subscriptionId, javax.servlet.http.HttpServletRequest request)
protected org.killbill.billing.ObjectType	getObjectType()
javax.ws.rs.core.Response	getTags(String subscriptionIdString, AuditMode auditMode, Boolean includedDeleted, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	uncancelEntitlementPlan(String subscriptionId, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)

Methods inherited from class org.killbill.billing.jaxrs.resources.JaxRsResourceBase

buildStreamingPaginationResponse, createControlPluginApiPaymentOptions, createControlPluginApiPaymentOptions, createCustomFields, createInvoicePaymentControlPluginApiPaymentOptions, createPurchaseForInvoice, createTagResponse, createTags, deleteCustomFields, deleteTags, extractPluginProperties, extractPluginProperties, getCustomFields, getInvoiceId, getPaymentTransactions, getTagDefinitionUUIDs, getTags, toLocalDate, toLocalDate, validatePaymentMethodForAccount, verifyNonNull, verifyNonNullOrEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionResource

@Inject
public SubscriptionResource(KillbillEventHandler killbillHandler,
                           JaxrsUriBuilder uriBuilder,
                           org.killbill.billing.util.api.TagUserApi tagUserApi,
                           org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi,
                           org.killbill.billing.util.api.AuditUserApi auditUserApi,
                           EntitlementApi entitlementApi,
                           SubscriptionApi subscriptionApi,
                           AccountUserApi accountUserApi,
                           PaymentApi paymentApi,
                           org.killbill.clock.Clock clock,
                           Context context)

Method Detail

getEntitlement

@Timed
public javax.ws.rs.core.Response getEntitlement(String subscriptionId,
                                             @Context
                                             javax.servlet.http.HttpServletRequest request)
                                         throws SubscriptionApiException

Throws:

SubscriptionApiException

createEntitlement

@Timed
public javax.ws.rs.core.Response createEntitlement(SubscriptionJson entitlement,
                                                String requestedDate,
                                                Boolean callCompletion,
                                                long timeoutSec,
                                                List<String> pluginPropertiesString,
                                                @HeaderParam(value="X-Killbill-CreatedBy")
                                                String createdBy,
                                                @HeaderParam(value="X-Killbill-Reason")
                                                String reason,
                                                @HeaderParam(value="X-Killbill-Comment")
                                                String comment,
                                                @Context
                                                javax.servlet.http.HttpServletRequest request,
                                                @Context
                                                javax.ws.rs.core.UriInfo uriInfo)
                                            throws EntitlementApiException,
                                                   AccountApiException,
                                                   SubscriptionApiException

Throws:

EntitlementApiException

AccountApiException

SubscriptionApiException

uncancelEntitlementPlan

@Timed
public javax.ws.rs.core.Response uncancelEntitlementPlan(String subscriptionId,
                                                      List<String> pluginPropertiesString,
                                                      @HeaderParam(value="X-Killbill-CreatedBy")
                                                      String createdBy,
                                                      @HeaderParam(value="X-Killbill-Reason")
                                                      String reason,
                                                      @HeaderParam(value="X-Killbill-Comment")
                                                      String comment,
                                                      @Context
                                                      javax.servlet.http.HttpServletRequest request)
                                                  throws EntitlementApiException

Throws:

EntitlementApiException

changeEntitlementPlan

@Timed
public javax.ws.rs.core.Response changeEntitlementPlan(SubscriptionJson entitlement,
                                                    String subscriptionId,
                                                    String requestedDate,
                                                    Boolean callCompletion,
                                                    long timeoutSec,
                                                    String policyString,
                                                    List<String> pluginPropertiesString,
                                                    @HeaderParam(value="X-Killbill-CreatedBy")
                                                    String createdBy,
                                                    @HeaderParam(value="X-Killbill-Reason")
                                                    String reason,
                                                    @HeaderParam(value="X-Killbill-Comment")
                                                    String comment,
                                                    @Context
                                                    javax.servlet.http.HttpServletRequest request)
                                                throws EntitlementApiException,
                                                       AccountApiException,
                                                       SubscriptionApiException

Throws:

EntitlementApiException

AccountApiException

SubscriptionApiException

cancelEntitlementPlan

@Timed
public javax.ws.rs.core.Response cancelEntitlementPlan(String subscriptionId,
                                                    String requestedDate,
                                                    Boolean callCompletion,
                                                    long timeoutSec,
                                                    String entitlementPolicyString,
                                                    String billingPolicyString,
                                                    Boolean useRequestedDateForBilling,
                                                    List<String> pluginPropertiesString,
                                                    @HeaderParam(value="X-Killbill-CreatedBy")
                                                    String createdBy,
                                                    @HeaderParam(value="X-Killbill-Reason")
                                                    String reason,
                                                    @HeaderParam(value="X-Killbill-Comment")
                                                    String comment,
                                                    @Context
                                                    javax.ws.rs.core.UriInfo uriInfo,
                                                    @Context
                                                    javax.servlet.http.HttpServletRequest request)
                                                throws EntitlementApiException,
                                                       AccountApiException,
                                                       SubscriptionApiException

Throws:

EntitlementApiException

AccountApiException

SubscriptionApiException

getCustomFields

public javax.ws.rs.core.Response getCustomFields(String id,
                                        AuditMode auditMode,
                                        @Context
                                        javax.servlet.http.HttpServletRequest request)

createCustomFields

public javax.ws.rs.core.Response createCustomFields(String id,
                                           List<CustomFieldJson> customFields,
                                           @HeaderParam(value="X-Killbill-CreatedBy")
                                           String createdBy,
                                           @HeaderParam(value="X-Killbill-Reason")
                                           String reason,
                                           @HeaderParam(value="X-Killbill-Comment")
                                           String comment,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo)
                                             throws org.killbill.billing.util.api.CustomFieldApiException

Throws:

org.killbill.billing.util.api.CustomFieldApiException

deleteCustomFields

public javax.ws.rs.core.Response deleteCustomFields(String id,
                                           String customFieldList,
                                           @HeaderParam(value="X-Killbill-CreatedBy")
                                           String createdBy,
                                           @HeaderParam(value="X-Killbill-Reason")
                                           String reason,
                                           @HeaderParam(value="X-Killbill-Comment")
                                           String comment,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request)
                                             throws org.killbill.billing.util.api.CustomFieldApiException

Throws:

org.killbill.billing.util.api.CustomFieldApiException

getTags

public javax.ws.rs.core.Response getTags(String subscriptionIdString,
                                AuditMode auditMode,
                                Boolean includedDeleted,
                                @Context
                                javax.servlet.http.HttpServletRequest request)
                                  throws org.killbill.billing.util.api.TagDefinitionApiException,
                                         SubscriptionApiException

Throws:

org.killbill.billing.util.api.TagDefinitionApiException

SubscriptionApiException

createTags

public javax.ws.rs.core.Response createTags(String id,
                                   String tagList,
                                   @HeaderParam(value="X-Killbill-CreatedBy")
                                   String createdBy,
                                   @HeaderParam(value="X-Killbill-Reason")
                                   String reason,
                                   @HeaderParam(value="X-Killbill-Comment")
                                   String comment,
                                   @Context
                                   javax.ws.rs.core.UriInfo uriInfo,
                                   @Context
                                   javax.servlet.http.HttpServletRequest request)
                                     throws org.killbill.billing.util.api.TagApiException

Throws:

org.killbill.billing.util.api.TagApiException

deleteTags

public javax.ws.rs.core.Response deleteTags(String id,
                                   String tagList,
                                   @HeaderParam(value="X-Killbill-CreatedBy")
                                   String createdBy,
                                   @HeaderParam(value="X-Killbill-Reason")
                                   String reason,
                                   @HeaderParam(value="X-Killbill-Comment")
                                   String comment,
                                   @Context
                                   javax.servlet.http.HttpServletRequest request)
                                     throws org.killbill.billing.util.api.TagApiException

Throws:

org.killbill.billing.util.api.TagApiException

getObjectType

protected org.killbill.billing.ObjectType getObjectType()

Overrides:

getObjectType in class JaxRsResourceBase