org.notima.camel.sveawebpay

Class WebpayAdminCamelClient

java.lang.Object

org.notima.camel.sveawebpay.WebpayAdminCamelClient

public class WebpayAdminCamelClient
extends Object

Class for accessing Svea Webpay APIs using camel. Copyright 2018 Notima System Integration AB (Sweden) Licensed 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.

Author:

Daniel Tamm

Constructor Summary

Constructors

Constructor and Description
WebpayAdminCamelClient() Creates an empty svea client.

Method Summary

Modifier and Type	Method and Description
com.svea.webpay.common.auth.SveaCredential	addCredentials(String accountNo, String username, String password) Adds credentials from camel headers.
List<org.notima.generic.businessobjects.Payment<com.svea.webpay.common.reconciliation.PaymentReportDetail>>	convertPaymentGroupToPayments(com.svea.webpay.common.reconciliation.PaymentReportGroup group, Boolean retriesOnly, Boolean feesOnPaymentLevel) Converts a SveaPayment Group to Business Object Payments
WebpayAdminCamelClient	createClientFromFile() Creates a client using the file path set in setJsonFile.
static WebpayAdminCamelClient	createClientFromIdentity(String username, String password) Creates a client from identity username and password.
static WebpayAdminCamelClient	createClientFromJsonBody(String orgNo, String body) Create a new instance of a svea client using the body as configuration.
String	createJsonConfigFromServices(String username, String password) Creates / compares configuration based on login (identity account)
com.svea.webpayadminservice.client.CreateOrderResponse2	createOrder(String accountNo, org.notima.generic.businessobjects.Order src) Creates and order from an OrderInvoice object.
com.svea.businessobjects.pmtadmin.SveaPmtAdminBusinessObjectFactory	createSveaPmtAdminBusinessObjectFactory(String serverName, String merchantId, String secretWord) Creates a SveaPmtAdminBusinessObjectFactory
String	deliverCheckoutOrder(String checkoutOrderNo) Delivers checkout order
com.svea.webpayadminservice.client.DeliveryResponse	deliverOrder(String accountNo, String orderType, String orderNo) Delivers an order (non-checkout).
String	getCardMerchantId()
com.svea.webpay.common.auth.SveaCredential	getCheckoutCredential()
com.svea.webpay.common.auth.SveaCredential	getCredentialFromAccountNo(String accountNo)
List<com.svea.webpay.common.auth.SveaCredential>	getCredentials() Gets credentials for this client.
String	getFromDate()
String	getJsonFile()
org.notima.generic.businessobjects.Order	getOrder(String accountNo, String orderId) Returns order data given Svea's order id.
org.notima.generic.businessobjects.Order	getOrderByCheckoutOrderId(String checkoutOrderId) Returns order data given checkout order id
org.notima.generic.businessobjects.Order	getOrderByClientOrderId(String accountNo, String clientOrderId) Returns order data given client's order id
String	getOrgNo()
List<String>	getReconcileDates(String reconcileDate, String lastReconcileDate) Gets a list of dates generated from lastReconcileDate Saturdays and sundays are excluded.
com.svea.webpay.common.reconciliation.PaymentReport	getReport() Returns the report
String	getReportAsJson() Returns the complete report in JSON.
String	getTodayMinusDaysStr(Integer days) Generates a date minus given number of days.
boolean	hasRetryEntries(com.svea.webpay.common.reconciliation.PaymentReport report) Returns true if the payment report has retry-entries.
com.svea.webpay.common.reconciliation.PaymentReportDetail	markForRetry(com.svea.webpay.common.reconciliation.PaymentReportDetail paymentDetail, Boolean retry) Marks given entry for retry
static void	overrideOptions(WebpayAdminCamelClient client, String accountNo, String includeKickbacks, String skipTaxId, String skipEmail, String enrichFromInvoice) Sets / overrides options on given credential.
com.svea.webpay.common.reconciliation.PaymentReport	readPayments(String orgNo, String clientName, String fromDateStr, String untilDateStr) Reads payments from given client.
static void	removeAllCredentialsBut(WebpayAdminCamelClient client, String accountNo) Removes all credentials but the given one
static void	removeCredential(WebpayAdminCamelClient client, String accountNo) Removes credential with given accountNo.
org.notima.generic.businessobjects.Payment	removeNativeReference(org.notima.generic.businessobjects.Payment detail) Removes reference to native payment (if this object is sent to a context) where the native reference isn't known.
void	setCredentialsFromJsonBody(String body) Sets credentials from body in json format
WebpayAdminCamelClient	setFromJsonBody(String json) Sets client credentials from jsonConfig.
void	setJsonFile(String jsonFile)
WebpayAdminCamelClient	setOrgNo(String orgNo) Sets orgNo and resets report and credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebpayAdminCamelClient

public WebpayAdminCamelClient()

Creates an empty svea client.

Method Detail

createClientFromJsonBody

public static WebpayAdminCamelClient createClientFromJsonBody(@Header(value="orgNo")
                                                              String orgNo,
                                                              String body)

Create a new instance of a svea client using the body as configuration.

Parameters:

orgNo - Org Number. If not null and the orgnumber isn't in the configuration orgNo is used.

body - Expected format is json-format of ListOfSveaCredentials

Returns:

If the body is empty, null is returned.

createClientFromIdentity

public static WebpayAdminCamelClient createClientFromIdentity(@Header(value="identityUser")
                                                              String username,
                                                              @Header(value="identityPass")
                                                              String password)
                                                       throws Exception

Creates a client from identity username and password.

Parameters:

username -

password -

Returns:

Throws:

Exception

createClientFromFile

public WebpayAdminCamelClient createClientFromFile()
                                            throws Exception

Creates a client using the file path set in setJsonFile.

Returns:

A client.

Throws:

Exception

setFromJsonBody

public WebpayAdminCamelClient setFromJsonBody(@Header(value="jsonConfig")
                                              String json)

Sets client credentials from jsonConfig.

Parameters:

json -

Returns:

setOrgNo

public WebpayAdminCamelClient setOrgNo(@Header(value="orgNo")
                                       String orgNo)

Sets orgNo and resets report and credentials.

Parameters:

orgNo -

getOrgNo

public String getOrgNo()

setCredentialsFromJsonBody

public void setCredentialsFromJsonBody(String body)

Sets credentials from body in json format

Parameters:

body -

getCredentials

public List<com.svea.webpay.common.auth.SveaCredential> getCredentials()

Gets credentials for this client.

Returns:

removeAllCredentialsBut

public static void removeAllCredentialsBut(@Header(value="client")
                                           WebpayAdminCamelClient client,
                                           @Header(value="credAccountNo")
                                           String accountNo)

Removes all credentials but the given one

removeCredential

public static void removeCredential(@Header(value="client")
                                    WebpayAdminCamelClient client,
                                    @Header(value="credAccountNo")
                                    String accountNo)

Removes credential with given accountNo.

Parameters:

accountNo - AccountNo to remove

overrideOptions

public static void overrideOptions(@Header(value="client")
                                   WebpayAdminCamelClient client,
                                   @Header(value="credAccountNo")
                                   String accountNo,
                                   @Header(value="includeKickbacks")
                                   String includeKickbacks,
                                   @Header(value="skipTaxId")
                                   String skipTaxId,
                                   @Header(value="skipEmail")
                                   String skipEmail,
                                   @Header(value="enrichFromInvoice")
                                   String enrichFromInvoice)

Sets / overrides options on given credential. If the options are null no change is made

Parameters:

client -

accountNo -

includeKickbacks -

skipTaxId -

skipEmail -

enrichFromInvoice -

addCredentials

public com.svea.webpay.common.auth.SveaCredential addCredentials(@Header(value="accountNo")
                                                                 String accountNo,
                                                                 @Header(value="username")
                                                                 String username,
                                                                 @Header(value="password")
                                                                 String password)

Adds credentials from camel headers.

Returns:

getOrder

public org.notima.generic.businessobjects.Order getOrder(@Header(value="accountNo")
                                                         String accountNo,
                                                         @Header(value="orderId")
                                                         String orderId)
                                                  throws Exception

Returns order data given Svea's order id.

Parameters:

accountNo - - Client ID

orderId -

Returns:

Throws:

Exception

getOrderByClientOrderId

public org.notima.generic.businessobjects.Order getOrderByClientOrderId(@Header(value="accountNo")
                                                                        String accountNo,
                                                                        @Header(value="clientOrderId")
                                                                        String clientOrderId)
                                                                 throws Exception

Returns order data given client's order id

Throws:

Exception

getOrderByCheckoutOrderId

public org.notima.generic.businessobjects.Order getOrderByCheckoutOrderId(@Header(value="checkoutOrderId")
                                                                          String checkoutOrderId)
                                                                   throws Exception

Returns order data given checkout order id

Throws:

Exception

createOrder

public com.svea.webpayadminservice.client.CreateOrderResponse2 createOrder(@Header(value="accountNo")
                                                                           String accountNo,
                                                                           org.notima.generic.businessobjects.Order src)
                                                                    throws Exception

Creates and order from an OrderInvoice object.

Parameters:

src -

Returns:

Throws:

Exception

getCredentialFromAccountNo

public com.svea.webpay.common.auth.SveaCredential getCredentialFromAccountNo(@Header(value="accountNo")
                                                                             String accountNo)

Parameters:

accountNo -

Returns:

Returns credentials using accountNo (identity) as key.

createJsonConfigFromServices

public String createJsonConfigFromServices(@Header(value="clientUsername")
                                           String username,
                                           @Header(value="clientPassword")
                                           String password)
                                    throws Exception

Creates / compares configuration based on login (identity account)

Throws:

Exception

getCheckoutCredential

public com.svea.webpay.common.auth.SveaCredential getCheckoutCredential()

Returns:

Returns checkout credentials (if they exist)

getCardMerchantId

public String getCardMerchantId()

Returns:

Returns card merchant ID. NOTE! The card merchant ID must be defined in the same credential as the merchant ID.

deliverCheckoutOrder

public String deliverCheckoutOrder(String checkoutOrderNo)
                            throws Exception

Delivers checkout order

Parameters:

checkoutOrderNo - The checkout order to deliver.

Returns:

Throws:

Exception

deliverOrder

public com.svea.webpayadminservice.client.DeliveryResponse deliverOrder(@Header(value="accountNo")
                                                                        String accountNo,
                                                                        @Header(value="orderType")
                                                                        String orderType,
                                                                        @Header(value="orderNo")
                                                                        String orderNo)
                                                                 throws Exception

Delivers an order (non-checkout).

Parameters:

accountNo -

orderNo -

Returns:

Throws:

Exception

getTodayMinusDaysStr

public String getTodayMinusDaysStr(@Header(value="days")
                                   Integer days)

Generates a date minus given number of days.

Parameters:

days -

Returns:

getReconcileDates

public List<String> getReconcileDates(@Header(value="reconcileDate")
                                      String reconcileDate,
                                      @Header(value="lastReconcileDate")
                                      String lastReconcileDate)
                               throws Exception

Gets a list of dates generated from lastReconcileDate Saturdays and sundays are excluded. If both reconcileDate and lastReconcileDate is null, the day before yesterday is used.

Parameters:

reconcileDate - If set, only this date is returned.

lastReconcileDate - If set and reconcileDate is null, all dates from lastReconcileDate until yesterday are returned.

Throws:

Exception

readPayments

public com.svea.webpay.common.reconciliation.PaymentReport readPayments(@Header(value="orgNo")
                                                                        String orgNo,
                                                                        @Header(value="clientName")
                                                                        String clientName,
                                                                        @Header(value="fromDate")
                                                                        String fromDateStr,
                                                                        @Header(value="untilDate")
                                                                        String untilDateStr)
                                                                 throws Exception

Reads payments from given client.

Parameters:

orgNo - The org number of the recipient

clientName - The client name of the recipient

fromDateStr - Read payments from this date

untilDateStr - Read payments until this date

Returns:

The payment report. The report is pruned before it's returned

Throws:

Exception

getFromDate

public String getFromDate()

Returns:

Returns the first reconciliation date in the first payment report group Returns null if there is no report group.

getReportAsJson

public String getReportAsJson()

Returns the complete report in JSON.

Returns:

getReport

public com.svea.webpay.common.reconciliation.PaymentReport getReport()

Returns the report

Returns:

convertPaymentGroupToPayments

public List<org.notima.generic.businessobjects.Payment<com.svea.webpay.common.reconciliation.PaymentReportDetail>> convertPaymentGroupToPayments(com.svea.webpay.common.reconciliation.PaymentReportGroup group,
                                                                                                                                                 @Header(value="processRetryPaymentsOnly")
                                                                                                                                                 Boolean retriesOnly,
                                                                                                                                                 @Header(value="feesOnPaymentLevel")
                                                                                                                                                 Boolean feesOnPaymentLevel)
                                                                                                                                          throws ParseException

Converts a SveaPayment Group to Business Object Payments

Parameters:

group - The group to be converted

retriesOnly - Only include payments marked for retry

feesOnPaymentLevel - Book fees on payment level (instead of total for the payment type).

Throws:

ParseException

removeNativeReference

public org.notima.generic.businessobjects.Payment removeNativeReference(org.notima.generic.businessobjects.Payment detail)

Removes reference to native payment (if this object is sent to a context) where the native reference isn't known.

Parameters:

detail -

Returns:

markForRetry

public com.svea.webpay.common.reconciliation.PaymentReportDetail markForRetry(@Header(value="paymentDetail")
                                                                              com.svea.webpay.common.reconciliation.PaymentReportDetail paymentDetail,
                                                                              @Header(value="retry")
                                                                              Boolean retry)

Marks given entry for retry

Parameters:

paymentDetail -

retry -

Returns:

hasRetryEntries

public boolean hasRetryEntries(@Header(value="paymentReport")
                               com.svea.webpay.common.reconciliation.PaymentReport report)

Returns true if the payment report has retry-entries. If retry entries are found, the group flag "processRetryPaymentsOnly" is set to true for every group with retry entries.

createSveaPmtAdminBusinessObjectFactory

public com.svea.businessobjects.pmtadmin.SveaPmtAdminBusinessObjectFactory createSveaPmtAdminBusinessObjectFactory(@Header(value="serverName")
                                                                                                                   String serverName,
                                                                                                                   @Header(value="merchantId")
                                                                                                                   String merchantId,
                                                                                                                   @Header(value="secretWord")
                                                                                                                   String secretWord)

Creates a SveaPmtAdminBusinessObjectFactory

Parameters:

serverName -

merchantId -

secretWord -

Returns:

getJsonFile

public String getJsonFile()

setJsonFile

public void setJsonFile(String jsonFile)