Java tutorial
/* * Copyright 2010-2013 Ning, Inc. * Copyright 2014-2016 Groupon, Inc * Copyright 2014-2016 The Billing Project, LLC * * The Billing Project licenses this file to you under the Apache License, version 2.0 * (the "License"); you may not use this file except in compliance with the * License. You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the * License for the specific language governing permissions and limitations * under the License. */ package org.killbill.billing.jaxrs.resources; import java.math.BigDecimal; import java.util.Collection; import java.util.HashMap; import java.util.LinkedList; import java.util.List; import java.util.Map; import java.util.UUID; import javax.servlet.http.HttpServletRequest; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; import javax.ws.rs.DefaultValue; import javax.ws.rs.GET; import javax.ws.rs.HeaderParam; import javax.ws.rs.POST; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.QueryParam; import javax.ws.rs.core.Response; import javax.ws.rs.core.UriInfo; import org.killbill.billing.ObjectType; import org.killbill.billing.account.api.Account; import org.killbill.billing.account.api.AccountApiException; import org.killbill.billing.account.api.AccountUserApi; import org.killbill.billing.invoice.api.InvoicePayment; import org.killbill.billing.invoice.api.InvoicePaymentApi; import org.killbill.billing.invoice.api.InvoicePaymentType; import org.killbill.billing.jaxrs.json.CustomFieldJson; import org.killbill.billing.jaxrs.json.InvoiceItemJson; import org.killbill.billing.jaxrs.json.InvoicePaymentJson; import org.killbill.billing.jaxrs.json.InvoicePaymentTransactionJson; import org.killbill.billing.jaxrs.json.TagJson; import org.killbill.billing.jaxrs.util.Context; import org.killbill.billing.jaxrs.util.JaxrsUriBuilder; import org.killbill.billing.payment.api.Payment; import org.killbill.billing.payment.api.PaymentApi; import org.killbill.billing.payment.api.PaymentApiException; import org.killbill.billing.payment.api.PluginProperty; import org.killbill.billing.util.UUIDs; import org.killbill.billing.util.api.AuditUserApi; import org.killbill.billing.util.api.CustomFieldApiException; import org.killbill.billing.util.api.CustomFieldUserApi; import org.killbill.billing.util.api.TagApiException; import org.killbill.billing.util.api.TagDefinitionApiException; import org.killbill.billing.util.api.TagUserApi; import org.killbill.billing.util.audit.AccountAuditLogs; import org.killbill.billing.util.callcontext.CallContext; import org.killbill.billing.util.callcontext.TenantContext; import org.killbill.clock.Clock; import org.killbill.commons.metrics.TimedResource; import com.google.common.base.Predicate; import com.google.common.base.Strings; import com.google.common.collect.ImmutableList; import com.google.common.collect.Iterables; import com.google.inject.Inject; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiResponse; import io.swagger.annotations.ApiResponses; import static javax.ws.rs.core.MediaType.APPLICATION_JSON; @Path(JaxrsResource.INVOICE_PAYMENTS_PATH) @Api(value = JaxrsResource.INVOICE_PAYMENTS_PATH, description = "Operations on invoice payments") public class InvoicePaymentResource extends JaxRsResourceBase { private static final String ID_PARAM_NAME = "paymentId"; private final InvoicePaymentApi invoicePaymentApi; @Inject public InvoicePaymentResource(final AccountUserApi accountUserApi, final PaymentApi paymentApi, final JaxrsUriBuilder uriBuilder, final TagUserApi tagUserApi, final CustomFieldUserApi customFieldUserApi, final AuditUserApi auditUserApi, final InvoicePaymentApi invoicePaymentApi, final Clock clock, final Context context) { super(uriBuilder, tagUserApi, customFieldUserApi, auditUserApi, accountUserApi, paymentApi, null, clock, context); this.invoicePaymentApi = invoicePaymentApi; } @TimedResource @GET @Path("/{paymentId:" + UUID_PATTERN + "}/") @Produces(APPLICATION_JSON) @ApiOperation(value = "Retrieve a payment by id", response = InvoicePaymentJson.class) @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid payment id supplied"), @ApiResponse(code = 404, message = "Payment not found") }) public Response getInvoicePayment(@PathParam("paymentId") final String paymentIdStr, @QueryParam(QUERY_WITH_PLUGIN_INFO) @DefaultValue("false") final Boolean withPluginInfo, @QueryParam(QUERY_WITH_ATTEMPTS) @DefaultValue("false") final Boolean withAttempts, @QueryParam(QUERY_PLUGIN_PROPERTY) final List<String> pluginPropertiesString, @QueryParam(QUERY_AUDIT) @DefaultValue("NONE") final AuditMode auditMode, @javax.ws.rs.core.Context final HttpServletRequest request) throws PaymentApiException { final Iterable<PluginProperty> pluginProperties = extractPluginProperties(pluginPropertiesString); final UUID paymentIdId = UUID.fromString(paymentIdStr); final TenantContext tenantContext = context.createContext(request); final Payment payment = paymentApi.getPayment(paymentIdId, withPluginInfo, withAttempts, pluginProperties, tenantContext); final AccountAuditLogs accountAuditLogs = auditUserApi.getAccountAuditLogs(payment.getAccountId(), auditMode.getLevel(), tenantContext); final List<InvoicePayment> invoicePayments = invoicePaymentApi.getInvoicePayments(paymentIdId, tenantContext); final InvoicePayment invoicePayment = Iterables.tryFind(invoicePayments, new Predicate<InvoicePayment>() { @Override public boolean apply(final InvoicePayment input) { return input.getType() == InvoicePaymentType.ATTEMPT && input.isSuccess(); } }).orNull(); final UUID invoiceId = invoicePayment != null ? invoicePayment.getInvoiceId() : null; final InvoicePaymentJson result = new InvoicePaymentJson(payment, invoiceId, accountAuditLogs); return Response.status(Response.Status.OK).entity(result).build(); } @TimedResource @POST @Path("/{paymentId:" + UUID_PATTERN + "}/" + REFUNDS) @Consumes(APPLICATION_JSON) @Produces(APPLICATION_JSON) @ApiOperation(value = "Refund a payment, and adjust the invoice if needed") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid payment id supplied"), @ApiResponse(code = 404, message = "Account or payment not found") }) public Response createRefundWithAdjustments(final InvoicePaymentTransactionJson json, @PathParam("paymentId") final String paymentId, @QueryParam(QUERY_PAYMENT_EXTERNAL) @DefaultValue("false") final Boolean externalPayment, @QueryParam(QUERY_PAYMENT_METHOD_ID) @DefaultValue("") final String paymentMethodId, @QueryParam(QUERY_PLUGIN_PROPERTY) final List<String> pluginPropertiesString, @HeaderParam(HDR_CREATED_BY) final String createdBy, @HeaderParam(HDR_REASON) final String reason, @HeaderParam(HDR_COMMENT) final String comment, @javax.ws.rs.core.Context final UriInfo uriInfo, @javax.ws.rs.core.Context final HttpServletRequest request) throws PaymentApiException, AccountApiException { verifyNonNullOrEmpty(json, "InvoicePaymentTransactionJson body should be specified"); final CallContext callContext = context.createContext(createdBy, reason, comment, request); final UUID paymentUuid = UUID.fromString(paymentId); final Payment payment = paymentApi.getPayment(paymentUuid, false, false, ImmutableList.<PluginProperty>of(), callContext); final Account account = accountUserApi.getAccountById(payment.getAccountId(), callContext); final Iterable<PluginProperty> pluginProperties; final String transactionExternalKey = json.getTransactionExternalKey() != null ? json.getTransactionExternalKey() : UUIDs.randomUUID().toString(); final String paymentExternalKey = json.getPaymentExternalKey() != null ? json.getPaymentExternalKey() : UUIDs.randomUUID().toString(); if (json.isAdjusted() != null && json.isAdjusted()) { if (json.getAdjustments() != null && json.getAdjustments().size() > 0) { final Map<UUID, BigDecimal> adjustments = new HashMap<UUID, BigDecimal>(); for (final InvoiceItemJson item : json.getAdjustments()) { adjustments.put(UUID.fromString(item.getInvoiceItemId()), item.getAmount()); } pluginProperties = extractPluginProperties(pluginPropertiesString, new PluginProperty("IPCD_REFUND_WITH_ADJUSTMENTS", "true", false), new PluginProperty("IPCD_REFUND_IDS_AMOUNTS", adjustments, false)); } else { pluginProperties = extractPluginProperties(pluginPropertiesString, new PluginProperty("IPCD_REFUND_WITH_ADJUSTMENTS", "true", false)); } } else { pluginProperties = extractPluginProperties(pluginPropertiesString); } final Payment result; if (externalPayment) { UUID externalPaymentMethodId = Strings.isNullOrEmpty(paymentMethodId) ? null : UUID.fromString(paymentMethodId); final Collection<PluginProperty> pluginPropertiesForExternalRefund = new LinkedList<PluginProperty>(); Iterables.addAll(pluginPropertiesForExternalRefund, pluginProperties); pluginPropertiesForExternalRefund.add(new PluginProperty("IPCD_PAYMENT_ID", paymentUuid, false)); result = paymentApi.createCreditWithPaymentControl(account, externalPaymentMethodId, null, json.getAmount(), account.getCurrency(), paymentExternalKey, transactionExternalKey, pluginPropertiesForExternalRefund, createInvoicePaymentControlPluginApiPaymentOptions(true), callContext); } else { result = paymentApi.createRefundWithPaymentControl(account, payment.getId(), json.getAmount(), account.getCurrency(), transactionExternalKey, pluginProperties, createInvoicePaymentControlPluginApiPaymentOptions(false), callContext); } return uriBuilder.buildResponse(uriInfo, InvoicePaymentResource.class, "getInvoicePayment", result.getId(), request); } @TimedResource @POST @Path("/{paymentId:" + UUID_PATTERN + "}/" + CHARGEBACKS) @Consumes(APPLICATION_JSON) @Produces(APPLICATION_JSON) @ApiOperation(value = "Record a chargeback") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid payment id supplied"), @ApiResponse(code = 404, message = "Account or payment not found") }) public Response createChargeback(final InvoicePaymentTransactionJson json, @PathParam("paymentId") final String paymentId, @HeaderParam(HDR_CREATED_BY) final String createdBy, @HeaderParam(HDR_REASON) final String reason, @HeaderParam(HDR_COMMENT) final String comment, @javax.ws.rs.core.Context final UriInfo uriInfo, @javax.ws.rs.core.Context final HttpServletRequest request) throws PaymentApiException, AccountApiException { verifyNonNullOrEmpty(json, "InvoicePaymentTransactionJson body should be specified"); verifyNonNullOrEmpty(json.getAmount(), "InvoicePaymentTransactionJson amount needs to be set"); final CallContext callContext = context.createContext(createdBy, reason, comment, request); final UUID paymentUuid = UUID.fromString(paymentId); final Payment payment = paymentApi.getPayment(paymentUuid, false, false, ImmutableList.<PluginProperty>of(), callContext); final Account account = accountUserApi.getAccountById(payment.getAccountId(), callContext); final String transactionExternalKey = json.getTransactionExternalKey() != null ? json.getTransactionExternalKey() : UUIDs.randomUUID().toString(); final Payment result = paymentApi.createChargebackWithPaymentControl(account, payment.getId(), json.getAmount(), account.getCurrency(), transactionExternalKey, createInvoicePaymentControlPluginApiPaymentOptions(false), callContext); return uriBuilder.buildResponse(uriInfo, InvoicePaymentResource.class, "getInvoicePayment", result.getId(), request); } @TimedResource @POST @Path("/{paymentId:" + UUID_PATTERN + "}/" + CHARGEBACK_REVERSALS) @Consumes(APPLICATION_JSON) @Produces(APPLICATION_JSON) @ApiOperation(value = "Record a chargebackReversal") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid payment id supplied"), @ApiResponse(code = 404, message = "Account or payment not found") }) public Response createChargebackReversal(final InvoicePaymentTransactionJson json, @PathParam("paymentId") final String paymentId, @HeaderParam(HDR_CREATED_BY) final String createdBy, @HeaderParam(HDR_REASON) final String reason, @HeaderParam(HDR_COMMENT) final String comment, @javax.ws.rs.core.Context final UriInfo uriInfo, @javax.ws.rs.core.Context final HttpServletRequest request) throws PaymentApiException, AccountApiException { verifyNonNullOrEmpty(json, "InvoicePaymentTransactionJson body should be specified"); verifyNonNullOrEmpty(json.getTransactionExternalKey(), "transactionExternalKey amount needs to be set"); final CallContext callContext = context.createContext(createdBy, reason, comment, request); final UUID paymentUuid = UUID.fromString(paymentId); final Payment payment = paymentApi.getPayment(paymentUuid, false, false, ImmutableList.<PluginProperty>of(), callContext); final Account account = accountUserApi.getAccountById(payment.getAccountId(), callContext); final Payment result = paymentApi.createChargebackReversalWithPaymentControl(account, payment.getId(), json.getTransactionExternalKey(), createInvoicePaymentControlPluginApiPaymentOptions(false), callContext); return uriBuilder.buildResponse(uriInfo, InvoicePaymentResource.class, "getInvoicePayment", result.getId(), request); } @TimedResource @GET @Path("/{paymentId:" + UUID_PATTERN + "}/" + CUSTOM_FIELDS) @Produces(APPLICATION_JSON) @ApiOperation(value = "Retrieve payment custom fields", response = CustomFieldJson.class, responseContainer = "List") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid payment id supplied") }) public Response getCustomFields(@PathParam(ID_PARAM_NAME) final String id, @QueryParam(QUERY_AUDIT) @DefaultValue("NONE") final AuditMode auditMode, @javax.ws.rs.core.Context final HttpServletRequest request) { return super.getCustomFields(UUID.fromString(id), auditMode, context.createContext(request)); } @TimedResource @POST @Path("/{paymentId:" + UUID_PATTERN + "}/" + CUSTOM_FIELDS) @Consumes(APPLICATION_JSON) @Produces(APPLICATION_JSON) @ApiOperation(value = "Add custom fields to payment") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid payment id supplied") }) public Response createCustomFields(@PathParam(ID_PARAM_NAME) final String id, final List<CustomFieldJson> customFields, @HeaderParam(HDR_CREATED_BY) final String createdBy, @HeaderParam(HDR_REASON) final String reason, @HeaderParam(HDR_COMMENT) final String comment, @javax.ws.rs.core.Context final HttpServletRequest request, @javax.ws.rs.core.Context final UriInfo uriInfo) throws CustomFieldApiException { return super.createCustomFields(UUID.fromString(id), customFields, context.createContext(createdBy, reason, comment, request), uriInfo, request); } @TimedResource @DELETE @Path("/{paymentId:" + UUID_PATTERN + "}/" + CUSTOM_FIELDS) @Consumes(APPLICATION_JSON) @Produces(APPLICATION_JSON) @ApiOperation(value = "Remove custom fields from payment") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid payment id supplied") }) public Response deleteCustomFields(@PathParam(ID_PARAM_NAME) final String id, @QueryParam(QUERY_CUSTOM_FIELDS) final String customFieldList, @HeaderParam(HDR_CREATED_BY) final String createdBy, @HeaderParam(HDR_REASON) final String reason, @HeaderParam(HDR_COMMENT) final String comment, @javax.ws.rs.core.Context final HttpServletRequest request) throws CustomFieldApiException { return super.deleteCustomFields(UUID.fromString(id), customFieldList, context.createContext(createdBy, reason, comment, request)); } @TimedResource @GET @Path("/{paymentId:" + UUID_PATTERN + "}/" + TAGS) @Produces(APPLICATION_JSON) @ApiOperation(value = "Retrieve payment tags", response = TagJson.class, responseContainer = "List") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid payment id supplied"), @ApiResponse(code = 404, message = "Payment not found") }) public Response getTags(@PathParam(ID_PARAM_NAME) final String paymentIdString, @QueryParam(QUERY_PLUGIN_PROPERTY) final List<String> pluginPropertiesString, @QueryParam(QUERY_AUDIT) @DefaultValue("NONE") final AuditMode auditMode, @QueryParam(QUERY_INCLUDED_DELETED) @DefaultValue("false") final Boolean includedDeleted, @javax.ws.rs.core.Context final HttpServletRequest request) throws TagDefinitionApiException, PaymentApiException { final Iterable<PluginProperty> pluginProperties = extractPluginProperties(pluginPropertiesString); final UUID paymentId = UUID.fromString(paymentIdString); final TenantContext tenantContext = context.createContext(request); final Payment payment = paymentApi.getPayment(paymentId, false, false, pluginProperties, tenantContext); return super.getTags(payment.getAccountId(), paymentId, auditMode, includedDeleted, tenantContext); } @TimedResource @POST @Path("/{paymentId:" + UUID_PATTERN + "}/" + TAGS) @Consumes(APPLICATION_JSON) @Produces(APPLICATION_JSON) @ApiOperation(value = "Add tags to payment") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid payment id supplied") }) public Response createTags(@PathParam(ID_PARAM_NAME) final String id, @QueryParam(QUERY_TAGS) final String tagList, @HeaderParam(HDR_CREATED_BY) final String createdBy, @HeaderParam(HDR_REASON) final String reason, @HeaderParam(HDR_COMMENT) final String comment, @javax.ws.rs.core.Context final UriInfo uriInfo, @javax.ws.rs.core.Context final HttpServletRequest request) throws TagApiException { return super.createTags(UUID.fromString(id), tagList, uriInfo, context.createContext(createdBy, reason, comment, request), request); } @TimedResource @DELETE @Path("/{paymentId:" + UUID_PATTERN + "}/" + TAGS) @Consumes(APPLICATION_JSON) @Produces(APPLICATION_JSON) @ApiOperation(value = "Remove tags from payment") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid payment id supplied") }) public Response deleteTags(@PathParam(ID_PARAM_NAME) final String id, @QueryParam(QUERY_TAGS) final String tagList, @HeaderParam(HDR_CREATED_BY) final String createdBy, @HeaderParam(HDR_REASON) final String reason, @HeaderParam(HDR_COMMENT) final String comment, @javax.ws.rs.core.Context final HttpServletRequest request) throws TagApiException { return super.deleteTags(UUID.fromString(id), tagList, context.createContext(createdBy, reason, comment, request)); } @Override protected ObjectType getObjectType() { return ObjectType.PAYMENT; } }