org.killbill.billing.jaxrs.resources

Class UsageResource

java.lang.Object

org.killbill.billing.jaxrs.resources.JaxRsResourceBase

org.killbill.billing.jaxrs.resources.UsageResource

All Implemented Interfaces:

JaxrsResource

public class UsageResource
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

UsageResource(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, org.killbill.billing.usage.api.UsageUserApi usageUserApi, PaymentApi paymentApi, EntitlementApi entitlementApi, org.killbill.clock.Clock clock, Context context)

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAllUsage(String subscriptionId, String startDate, String endDate, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getUsage(String subscriptionId, String unitType, String startDate, String endDate, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	recordUsage(SubscriptionUsageRecordJson json, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)

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

buildStreamingPaginationResponse, createControlPluginApiPaymentOptions, createControlPluginApiPaymentOptions, createCustomFields, createInvoicePaymentControlPluginApiPaymentOptions, createPurchaseForInvoice, createTagResponse, createTags, deleteCustomFields, deleteTags, extractPluginProperties, extractPluginProperties, getCustomFields, getInvoiceId, getObjectType, 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

UsageResource

@Inject
public UsageResource(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,
                    org.killbill.billing.usage.api.UsageUserApi usageUserApi,
                    PaymentApi paymentApi,
                    EntitlementApi entitlementApi,
                    org.killbill.clock.Clock clock,
                    Context context)

Method Detail

recordUsage

@Timed
public javax.ws.rs.core.Response recordUsage(SubscriptionUsageRecordJson json,
                                          @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

Throws:

EntitlementApiException

AccountApiException

getUsage

@Timed
public javax.ws.rs.core.Response getUsage(String subscriptionId,
                                       String unitType,
                                       String startDate,
                                       String endDate,
                                       @Context
                                       javax.servlet.http.HttpServletRequest request)

getAllUsage

@Timed
public javax.ws.rs.core.Response getAllUsage(String subscriptionId,
                                          String startDate,
                                          String endDate,
                                          @Context
                                          javax.servlet.http.HttpServletRequest request)