Package org.killbill.billing.jaxrs.resources

Class TenantResource

java.lang.Object

org.killbill.billing.jaxrs.resources.JaxRsResourceBase

org.killbill.billing.jaxrs.resources.TenantResource

All Implemented Interfaces:

JaxrsResource

@Singleton
@Path("/1.0/kb/tenants")
public class TenantResource
extends JaxRsResourceBase

Field Summary

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

accountUserApi, auditUserApi, catalogName, clock, context, customFieldUserApi, DATE_TIME_FORMATTER, invoicePaymentApi, LOCAL_DATE_FORMATTER, mapper, paymentApi, subscriptionApi, tagUserApi, uriBuilder

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

ACCOUNTS, ACCOUNTS_PATH, ADMIN, ADMIN_PATH, ALL_CUSTOM_FIELDS, ALL_TAGS, ANALYTICS, ANALYTICS_PATH, ANYTHING_PATTERN, API_POSTFIX, API_PREFIX, API_VERSION, ATTEMPTS, AUDIT_LOG, AUDIT_LOG_WITH_HISTORY, 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, EVENTS, EXPORT, EXPORT_PATH, FORM, GROUP, 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, HEALTHCHECK, HOSTED, INVOICE_CATALOG_TRANSLATION, INVOICE_ITEMS, INVOICE_MP_TEMPLATE, INVOICE_PAYMENTS, INVOICE_PAYMENTS_PATH, INVOICE_TEMPLATE, INVOICE_TRANSLATION, INVOICES, INVOICES_ITEMS_PATH, INVOICES_PATH, MIGRATION, NODES_INFO, NODES_INFO_PATH, NOTIFICATION, NUMBER_PATTERN, OVERDUE, OVERDUE_PATH, PAGINATION, PATH_PAYMENT_PLUGIN_NAME, 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_INFO, PLUGINS_INFO_PATH, PLUGINS_PATH, PREFIX, QUANTITY, QUERY_ACCOUNT_ID, QUERY_ACCOUNT_TREAT_NULL_AS_RESET, QUERY_ACCOUNT_WITH_BALANCE, QUERY_ACCOUNT_WITH_BALANCE_AND_CBA, QUERY_API_KEY, QUERY_AUDIT, QUERY_AUTO_COMMIT, QUERY_BCD_TRANSFER, QUERY_BILLING_POLICY, QUERY_BILLING_REQUESTED_DT, QUERY_BLOCKING_STATE_SVCS, QUERY_BLOCKING_STATE_TYPES, QUERY_BUNDLES_FILTER, QUERY_BUNDLES_RENAME_KEY_IF_EXIST_UNUSED, QUERY_CALL_COMPLETION, QUERY_CALL_TIMEOUT, QUERY_CANCEL_ALL_SUBSCRIPTIONS, QUERY_CUSTOM_FIELD, 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_FORCE_NEW_BCD_WITH_PAST_EFFECTIVE_DATE, QUERY_FORCE_NEW_QUANTITY_WITH_PAST_EFFECTIVE_DATE, QUERY_INCLUDE_INVOICE_COMPONENTS, QUERY_INCLUDE_VOIDED_INVOICES, QUERY_INCLUDED_DELETED, QUERY_INVOICE_WITH_CHILDREN_ITEMS, QUERY_INVOICES_FILTER, QUERY_ITEM_ADJUST_UNPAID_INVOICES, 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_REMOVE_FUTURE_NOTIFICATIONS, QUERY_REQUESTED_DT, QUERY_SEARCH_LIMIT, QUERY_SEARCH_OFFSET, QUERY_SKIP_RESPONSE, QUERY_START_DATE, QUERY_TAG, 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, QUERY_WRITE_OFF_UNPAID_INVOICES, REFUNDS, REGISTER_NOTIFICATION_CALLBACK, RENAME_KEY, RESUME, SEARCH, SECURITY, SECURITY_PATH, STRING_PATTERN, SUBSCRIPTIONS, SUBSCRIPTIONS_PATH, TAG_DEFINITIONS, TAG_DEFINITIONS_PATH, TAGS, TAGS_PATH, TAXES, TENANTS, TENANTS_PATH, TEST, TEST_PATH, TIMELINE, TRANSFER_CREDIT, UNDO_CANCEL, UNDO_CHANGE_PLAN, UPLOAD_PER_TENANT_CONFIG, UPLOAD_PLUGIN_CONFIG, UPLOAD_PLUGIN_PAYMENT_STATE_MACHINE_CONFIG, USAGES, USAGES_PATH, USER_KEY_VALUE, UUID_PATTERN, VOID_INVOICE

Constructor Summary

Constructors

Constructor

Description

TenantResource(TenantUserApi tenantApi, 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, InvoicePaymentApi invoicePaymentApi, CatalogUserApi catalogUserApi, org.killbill.clock.Clock clock, Context context)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createTenant(TenantJson json, Boolean useGlobalDefault, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	deletePerTenantConfiguration(String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deletePluginConfiguration(String pluginName, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deletePluginPaymentStateMachineConfig(String pluginName, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deletePushNotificationCallbacks(String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deleteUserKeyValue(String key, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAllPluginConfiguration(String keyPrefix, javax.servlet.http.HttpServletRequest request)
protected org.killbill.billing.ObjectType	getObjectType()
javax.ws.rs.core.Response	getPerTenantConfiguration(javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getPluginConfiguration(String pluginName, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getPluginPaymentStateMachineConfig(String pluginName, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getPushNotificationCallbacks(javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getTenant(UUID tenantId)
javax.ws.rs.core.Response	getTenantByApiKey(String externalKey)
javax.ws.rs.core.Response	getUserKeyValue(String key, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	insertUserKeyValue(String key, String value, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	registerPushNotificationCallback(String notificationCallback, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	uploadPerTenantConfiguration(String perTenantConfig, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	uploadPluginConfiguration(String pluginName, String pluginConfig, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	uploadPluginPaymentStateMachineConfig(String pluginName, String paymentStateMachineConfig, 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

addBlockingState, buildStreamingPaginationResponse, completeTransactionInternal, createControlPluginApiPaymentOptions, createControlPluginApiPaymentOptions, createCustomFieldResponse, createCustomFields, createInvoicePaymentControlPluginApiPaymentOptions, createPaymentResponse, createPurchaseForInvoice, createPurchaseForInvoice, createTagResponse, createTags, deleteCustomFields, deleteTags, extractPluginProperties, extractPluginProperties, getAuditLogsWithHistory, getCustomFields, getInvoiceId, getPaymentByIdOrKey, getPaymentTransactions, getTagDefinitionUUIDs, getTags, isDateTime, lookupPendingOrSuccessTransaction, modifyCustomFields, toDateTime, toLocalDate, toLocalDateDefaultToday, toLocalDateDefaultToday, validatePaymentMethodForAccount, validateSanitizeAndTranformInputItems, verifyNonNull, verifyNonNullOrEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

TenantResource

@Inject
public TenantResource(TenantUserApi tenantApi,
                      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,
                      InvoicePaymentApi invoicePaymentApi,
                      CatalogUserApi catalogUserApi,
                      org.killbill.clock.Clock clock,
                      Context context)

Method Detail

getTenant

@GET
@Path("/{tenantId:\\w+-\\w+-\\w+-\\w+-\\w+}")
@Produces("application/json")
public javax.ws.rs.core.Response getTenant(@PathParam("tenantId")
                                           UUID tenantId)
                                    throws TenantApiException

Throws:

TenantApiException

getTenantByApiKey

@GET
@Produces("application/json")
public javax.ws.rs.core.Response getTenantByApiKey(@QueryParam("apiKey")
                                                   String externalKey)
                                            throws TenantApiException

Throws:

TenantApiException

createTenant

@POST
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response createTenant(TenantJson json,
                                              @QueryParam("useGlobalDefault") @DefaultValue("false")
                                              Boolean useGlobalDefault,
                                              @HeaderParam("X-Killbill-CreatedBy")
                                              String createdBy,
                                              @HeaderParam("X-Killbill-Reason")
                                              String reason,
                                              @HeaderParam("X-Killbill-Comment")
                                              String comment,
                                              @Context
                                              javax.servlet.http.HttpServletRequest request,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo)
                                       throws TenantApiException,
                                              CatalogApiException

Throws:

TenantApiException

CatalogApiException

registerPushNotificationCallback

@POST
@Path("/registerNotificationCallback")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response registerPushNotificationCallback(@QueryParam("cb")
                                                                  String notificationCallback,
                                                                  @HeaderParam("X-Killbill-CreatedBy")
                                                                  String createdBy,
                                                                  @HeaderParam("X-Killbill-Reason")
                                                                  String reason,
                                                                  @HeaderParam("X-Killbill-Comment")
                                                                  String comment,
                                                                  @Context
                                                                  javax.servlet.http.HttpServletRequest request,
                                                                  @Context
                                                                  javax.ws.rs.core.UriInfo uriInfo)
                                                           throws TenantApiException

Throws:

TenantApiException

getPushNotificationCallbacks

@GET
@Path("/registerNotificationCallback")
@Produces("application/json")
public javax.ws.rs.core.Response getPushNotificationCallbacks(@Context
                                                              javax.servlet.http.HttpServletRequest request)
                                                       throws TenantApiException

Throws:

TenantApiException

deletePushNotificationCallbacks

@DELETE
@Path("/registerNotificationCallback")
public javax.ws.rs.core.Response deletePushNotificationCallbacks(@HeaderParam("X-Killbill-CreatedBy")
                                                                 String createdBy,
                                                                 @HeaderParam("X-Killbill-Reason")
                                                                 String reason,
                                                                 @HeaderParam("X-Killbill-Comment")
                                                                 String comment,
                                                                 @Context
                                                                 javax.servlet.http.HttpServletRequest request)
                                                          throws TenantApiException

Throws:

TenantApiException

uploadPluginConfiguration

@POST
@Path("/uploadPluginConfig/{pluginName:.*}")
@Consumes("text/plain")
@Produces("application/json")
public javax.ws.rs.core.Response uploadPluginConfiguration(@PathParam("pluginName")
                                                           String pluginName,
                                                           String pluginConfig,
                                                           @HeaderParam("X-Killbill-CreatedBy")
                                                           String createdBy,
                                                           @HeaderParam("X-Killbill-Reason")
                                                           String reason,
                                                           @HeaderParam("X-Killbill-Comment")
                                                           String comment,
                                                           @Context
                                                           javax.servlet.http.HttpServletRequest request,
                                                           @Context
                                                           javax.ws.rs.core.UriInfo uriInfo)
                                                    throws TenantApiException

Throws:

TenantApiException

getPluginConfiguration

@GET
@Path("/uploadPluginConfig/{pluginName:.*}")
@Produces("application/json")
public javax.ws.rs.core.Response getPluginConfiguration(@PathParam("pluginName")
                                                        String pluginName,
                                                        @Context
                                                        javax.servlet.http.HttpServletRequest request)
                                                 throws TenantApiException

Throws:

TenantApiException

deletePluginConfiguration

@DELETE
@Path("/uploadPluginConfig/{pluginName:.*}")
public javax.ws.rs.core.Response deletePluginConfiguration(@PathParam("pluginName")
                                                           String pluginName,
                                                           @HeaderParam("X-Killbill-CreatedBy")
                                                           String createdBy,
                                                           @HeaderParam("X-Killbill-Reason")
                                                           String reason,
                                                           @HeaderParam("X-Killbill-Comment")
                                                           String comment,
                                                           @Context
                                                           javax.servlet.http.HttpServletRequest request)
                                                    throws TenantApiException

Throws:

TenantApiException

getAllPluginConfiguration

@GET
@Path("/uploadPerTenantConfig/{keyPrefix:.*}/search")
@Produces("application/json")
public javax.ws.rs.core.Response getAllPluginConfiguration(@PathParam("keyPrefix")
                                                           String keyPrefix,
                                                           @Context
                                                           javax.servlet.http.HttpServletRequest request)
                                                    throws TenantApiException

Throws:

TenantApiException

uploadPerTenantConfiguration

@POST
@Path("/uploadPerTenantConfig")
@Consumes("text/plain")
@Produces("application/json")
public javax.ws.rs.core.Response uploadPerTenantConfiguration(String perTenantConfig,
                                                              @HeaderParam("X-Killbill-CreatedBy")
                                                              String createdBy,
                                                              @HeaderParam("X-Killbill-Reason")
                                                              String reason,
                                                              @HeaderParam("X-Killbill-Comment")
                                                              String comment,
                                                              @Context
                                                              javax.servlet.http.HttpServletRequest request,
                                                              @Context
                                                              javax.ws.rs.core.UriInfo uriInfo)
                                                       throws TenantApiException

Throws:

TenantApiException

getPerTenantConfiguration

@GET
@Path("/uploadPerTenantConfig")
@Produces("application/json")
public javax.ws.rs.core.Response getPerTenantConfiguration(@Context
                                                           javax.servlet.http.HttpServletRequest request)
                                                    throws TenantApiException

Throws:

TenantApiException

deletePerTenantConfiguration

@DELETE
@Path("/uploadPerTenantConfig")
public javax.ws.rs.core.Response deletePerTenantConfiguration(@HeaderParam("X-Killbill-CreatedBy")
                                                              String createdBy,
                                                              @HeaderParam("X-Killbill-Reason")
                                                              String reason,
                                                              @HeaderParam("X-Killbill-Comment")
                                                              String comment,
                                                              @Context
                                                              javax.servlet.http.HttpServletRequest request)
                                                       throws TenantApiException

Throws:

TenantApiException

uploadPluginPaymentStateMachineConfig

@POST
@Path("/uploadPluginPaymentStateMachineConfig/{pluginName:.*}")
@Consumes("text/plain")
@Produces("application/json")
public javax.ws.rs.core.Response uploadPluginPaymentStateMachineConfig(@PathParam("pluginName")
                                                                       String pluginName,
                                                                       String paymentStateMachineConfig,
                                                                       @HeaderParam("X-Killbill-CreatedBy")
                                                                       String createdBy,
                                                                       @HeaderParam("X-Killbill-Reason")
                                                                       String reason,
                                                                       @HeaderParam("X-Killbill-Comment")
                                                                       String comment,
                                                                       @Context
                                                                       javax.servlet.http.HttpServletRequest request,
                                                                       @Context
                                                                       javax.ws.rs.core.UriInfo uriInfo)
                                                                throws TenantApiException

Throws:

TenantApiException

getPluginPaymentStateMachineConfig

@GET
@Path("/uploadPluginPaymentStateMachineConfig/{pluginName:.*}")
@Produces("application/json")
public javax.ws.rs.core.Response getPluginPaymentStateMachineConfig(@PathParam("pluginName")
                                                                    String pluginName,
                                                                    @Context
                                                                    javax.servlet.http.HttpServletRequest request)
                                                             throws TenantApiException

Throws:

TenantApiException

deletePluginPaymentStateMachineConfig

@DELETE
@Path("/uploadPluginPaymentStateMachineConfig/{pluginName:.*}")
public javax.ws.rs.core.Response deletePluginPaymentStateMachineConfig(@PathParam("pluginName")
                                                                       String pluginName,
                                                                       @HeaderParam("X-Killbill-CreatedBy")
                                                                       String createdBy,
                                                                       @HeaderParam("X-Killbill-Reason")
                                                                       String reason,
                                                                       @HeaderParam("X-Killbill-Comment")
                                                                       String comment,
                                                                       @Context
                                                                       javax.servlet.http.HttpServletRequest request)
                                                                throws TenantApiException

Throws:

TenantApiException

insertUserKeyValue

@POST
@Path("/userKeyValue/{keyName:.*}")
@Consumes("text/plain")
@Produces("application/json")
public javax.ws.rs.core.Response insertUserKeyValue(@PathParam("keyName")
                                                    String key,
                                                    String value,
                                                    @HeaderParam("X-Killbill-CreatedBy")
                                                    String createdBy,
                                                    @HeaderParam("X-Killbill-Reason")
                                                    String reason,
                                                    @HeaderParam("X-Killbill-Comment")
                                                    String comment,
                                                    @Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    @Context
                                                    javax.ws.rs.core.UriInfo uriInfo)
                                             throws TenantApiException

Throws:

TenantApiException

getUserKeyValue

@GET
@Path("/userKeyValue/{keyName:.*}")
@Produces("application/json")
public javax.ws.rs.core.Response getUserKeyValue(@PathParam("keyName")
                                                 String key,
                                                 @Context
                                                 javax.servlet.http.HttpServletRequest request)
                                          throws TenantApiException

Throws:

TenantApiException

deleteUserKeyValue

@DELETE
@Path("/userKeyValue/{keyName:.*}")
public javax.ws.rs.core.Response deleteUserKeyValue(@PathParam("keyName")
                                                    String key,
                                                    @HeaderParam("X-Killbill-CreatedBy")
                                                    String createdBy,
                                                    @HeaderParam("X-Killbill-Reason")
                                                    String reason,
                                                    @HeaderParam("X-Killbill-Comment")
                                                    String comment,
                                                    @Context
                                                    javax.servlet.http.HttpServletRequest request)
                                             throws TenantApiException

Throws:

TenantApiException

getObjectType

protected org.killbill.billing.ObjectType getObjectType()

Overrides:

getObjectType in class JaxRsResourceBase