Package software.xdev.bzst.dip.client.webclient

Class WebClient

java.lang.Object

software.xdev.bzst.dip.client.webclient.WebClient

public class WebClient
extends Object

Helps to communicate with the BZST API.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	OK_HTTP_STATUS_CODE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	abortSubmission(String dataTransferNumber)
void	closeSubmission(String dataTransferNumber)	Requests the closing of the submission with the given dataTransferNumber.
BzstDipSingleTransferResult	confirmTransfer(String dataTransferNumber)	Confirm the result protocol
String	getDataTransferNumber()
String	getDataTransferNumber(String fachverfahren)
BzstDipRequestStatusResult	readAndConfirmDataTransferNumbers()	Gets all data transfer numbers.
List<String>	requestResultLogs()	Retrieval of the results log
BzstDipSingleTransferResult	requestTransferResult(String dataTransferNumber)	Get the result protocol
void	uploadMassData(String dataTransferNumber, String xmlString)

Methods inherited from class java.lang.Object

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

Field Details

OK_HTTP_STATUS_CODE

public static final int OK_HTTP_STATUS_CODE

See Also:

• Constant Field Values

Constructor Details

WebClient

public WebClient(BzstDipConfiguration configuration)

WebClient

public WebClient(BzstDipConfiguration configuration,
 ApiClient apiClient)

WebClient

public WebClient(BzstDipConfiguration configuration,
 MdEinreichenProviderApi mdEinreichenProviderApi)

Method Details

getDataTransferNumber

public String getDataTransferNumber()

Returns:

XML as string with data transfer numbers

getDataTransferNumber

public String getDataTransferNumber(String fachverfahren)

uploadMassData

public void uploadMassData(String dataTransferNumber,
 String xmlString)

closeSubmission

public void closeSubmission(String dataTransferNumber)

Requests the closing of the submission with the given dataTransferNumber.

requestResultLogs

public List<String> requestResultLogs()
                               throws IOException

Retrieval of the results log

Returns:

String list with data transfer numbers

Throws:

IOException

requestTransferResult

public BzstDipSingleTransferResult requestTransferResult(String dataTransferNumber)
                                                  throws IOException

Get the result protocol

Returns:

Returns complete HttpResponse

Throws:

IOException

confirmTransfer

public BzstDipSingleTransferResult confirmTransfer(String dataTransferNumber)

Confirm the result protocol

abortSubmission

public void abortSubmission(String dataTransferNumber)

readAndConfirmDataTransferNumbers

public BzstDipRequestStatusResult readAndConfirmDataTransferNumbers()
                                                             throws IOException

Gets all data transfer numbers. Get the result protocol from a transfer number and confirm them if possible.

Returns:

returns true if the method should be called later again because the result is not yet available

Throws:

IOException