Package software.xdev.bzst.dip.client

Class BzstDipClient

java.lang.Object

software.xdev.bzst.dip.client.BzstDipClient

public class BzstDipClient
extends Object

Uses the WebClient to send BzstDipMessages to the BZST DIP API.

Constructor Summary

Constructors

Constructor	Description
BzstDipClient(BzstDipConfiguration configuration)
BzstDipClient(BzstDipConfiguration configuration, MdEinreichenProviderApi mdEinreichenProviderApi)
BzstDipClient(BzstDipConfiguration configuration, ApiClient apiClient)
BzstDipClient(BzstDipConfiguration configuration, WebClient webClient)

Method Summary

Modifier and Type	Method	Description
BzstDipRequestStatusResult	queryDipResult()	Queries for a DIP result.
BzstDipCompleteResult	sendDipAndQueryResult(String csvData)	Sends the message and queries a result.
BzstDipCompleteResult	sendDipAndQueryResult(List<CorrectableReportableSellerType> correctableReportableSellerTypes)	Sends the message and queries a result.
BzstDipCompleteResult	sendDipAndQueryResult(List<CorrectableReportableSellerType> correctableReportableSellerTypes, CorrectablePlatformOperatorType correctablePlatformOperatorType)	Sends the message and queries a result.
BzstDipCompleteResult	sendDipAndQueryResult(BzstCesopPaymentDataBody message)
BzstDipCompleteResult	sendDipAndQueryResult(BzstDipMessage message)	Sends the message and queries a result.
BzstDipCompleteResult	sendDipAndQueryResult(PaymentDataBodyType paymentDataBodyType)
BzstDipSendingResult	sendDipOnly(String csvData)	Sends the message without querying for a response.
BzstDipSendingResult	sendDipOnly(List<CorrectableReportableSellerType> correctableReportableSellerTypes)	Sends the message without querying for a response.
BzstDipSendingResult	sendDipOnly(List<CorrectableReportableSellerType> correctableReportableSellerTypes, CorrectablePlatformOperatorType correctablePlatformOperatorType)	Sends the message without querying for a response.
BzstDipSendingResult	sendDipOnly(BzstDipMessage message)	Sends the message without querying for a response.

Methods inherited from class java.lang.Object

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

Constructor Details

BzstDipClient

public BzstDipClient(BzstDipConfiguration configuration)

BzstDipClient

public BzstDipClient(BzstDipConfiguration configuration,
 ApiClient apiClient)

BzstDipClient

public BzstDipClient(BzstDipConfiguration configuration,
 MdEinreichenProviderApi mdEinreichenProviderApi)

BzstDipClient

public BzstDipClient(BzstDipConfiguration configuration,
 WebClient webClient)

Method Details

sendDipOnly

public BzstDipSendingResult sendDipOnly(BzstDipMessage message)

Sends the message without querying for a response. We recommend using the sendDipAndQueryResult(BzstDipMessage) counterpart and suggest only using this method, if specifically needed.

Parameters:

message - with the data for the BZST DIP API.

Returns:

the result which only contains the dataTransferNumber

sendDipOnly

public BzstDipSendingResult sendDipOnly(String csvData)
                                 throws IOException

Sends the message without querying for a response. We recommend using the sendDipAndQueryResult(String) counterpart and suggest only using this method, if specifically needed.

Parameters:

csvData - which will be parsed by the ReportableSellerCsvFileParser.

Returns:

the result which only contains the dataTransferNumber

Throws:

IOException

sendDipOnly

public BzstDipSendingResult sendDipOnly(List<CorrectableReportableSellerType> correctableReportableSellerTypes)

Sends the message without querying for a response. We recommend using the sendDipAndQueryResult(List) counterpart and suggest only using this method, if specifically needed.

Parameters:

correctableReportableSellerTypes - with the data for the BZST DIP API.

Returns:

the result which only contains the dataTransferNumber

sendDipOnly

public BzstDipSendingResult sendDipOnly(List<CorrectableReportableSellerType> correctableReportableSellerTypes,
 CorrectablePlatformOperatorType correctablePlatformOperatorType)

Sends the message without querying for a response. We recommend using the sendDipAndQueryResult(List, CorrectablePlatformOperatorType) counterpart and suggest only using this method, if specifically needed.

Parameters:

correctableReportableSellerTypes - with the data for the BZST DIP API.

correctablePlatformOperatorType - with the information about the platform operator.

Returns:

the result which only contains the dataTransferNumber

sendDipAndQueryResult

public BzstDipCompleteResult sendDipAndQueryResult(BzstDipMessage message)
                                            throws InterruptedException,
IOException

Sends the message and queries a result.

Querying the result might take a few seconds and is configured in BzstDipConfiguration.getQueryResultConfiguration().

In special cases sendDipOnly(BzstDipMessage) can be used, if the result is not needed, or the results should be queried in some other way.

Parameters:

message - with the data for the BZST DIP API.

Returns:

the result which contains the dataTransferNumber and all found responses in the API.

Throws:

InterruptedException

IOException

sendDipAndQueryResult

public BzstDipCompleteResult sendDipAndQueryResult(BzstCesopPaymentDataBody message)
                                            throws InterruptedException,
IOException,
DatatypeConfigurationException

Throws:

InterruptedException

IOException

DatatypeConfigurationException

sendDipAndQueryResult

public BzstDipCompleteResult sendDipAndQueryResult(String csvData)
                                            throws InterruptedException,
IOException

Sends the message and queries a result.

Querying the result might take a few seconds and is configured in BzstDipConfiguration.getQueryResultConfiguration().

In special cases sendDipOnly(String) can be used, if the result is not needed, or the results should be queried in some other way.

Parameters:

csvData - which will be parsed by the ReportableSellerCsvFileParser.

Returns:

the result which contains the dataTransferNumber and all found responses in the API.

Throws:

InterruptedException

IOException

sendDipAndQueryResult

public BzstDipCompleteResult sendDipAndQueryResult(List<CorrectableReportableSellerType> correctableReportableSellerTypes)
                                            throws InterruptedException,
IOException

Sends the message and queries a result.

Querying the result might take a few seconds and is configured in BzstDipConfiguration.getQueryResultConfiguration().

In special cases sendDipOnly(List) can be used, if the result is not needed, or the results should be queried in some other way.

Parameters:

correctableReportableSellerTypes - with the data for the BZST DIP API.

Returns:

the result which contains the dataTransferNumber and all found responses in the API.

Throws:

InterruptedException

IOException

sendDipAndQueryResult

public BzstDipCompleteResult sendDipAndQueryResult(List<CorrectableReportableSellerType> correctableReportableSellerTypes,
 CorrectablePlatformOperatorType correctablePlatformOperatorType)
                                            throws InterruptedException,
IOException

Sends the message and queries a result.

Querying the result might take a few seconds and is configured in BzstDipConfiguration.getQueryResultConfiguration().

In special cases sendDipOnly(List, CorrectablePlatformOperatorType) can be used, if the result is not needed, or the results should be queried in some other way.

Parameters:

correctableReportableSellerTypes - with the data for the BZST DIP API.

correctablePlatformOperatorType - with the information about the platform operator.

Returns:

the result which contains the dataTransferNumber and all found responses in the API.

Throws:

InterruptedException

IOException

sendDipAndQueryResult

public BzstDipCompleteResult sendDipAndQueryResult(PaymentDataBodyType paymentDataBodyType)
                                            throws InterruptedException,
IOException

Throws:

InterruptedException

IOException

queryDipResult

public BzstDipRequestStatusResult queryDipResult()
                                          throws IOException

Queries for a DIP result. We recommend using the sendDipAndQueryResult(BzstDipMessage) counterpart and suggest only using this method, if specifically needed.

Returns:

all found BzstDipSingleTransferResults

Throws:

IOException