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

Class WebClient

java.lang.Object

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

All Implemented Interfaces:

AutoCloseable

public class WebClient
extends Object
implements AutoCloseable

Helps to communicate with the BZST API.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DIP_MD
static final int	OK_HTTP_STATUS_CODE
static final String	PATCH

Constructor Summary

Constructors

Constructor	Description
WebClient(BzstDipConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
String	abortSubmission(String dataTransferNumber)
void	close()
String	closeSubmission(String dataTransferNumber)	Requests the closing of the submission with the given dataTransferNumber.
BzstDipSingleTransferResult	confirmTransfer(String transferNumber)	Confirm the result protocol
HttpRequest	createAbortSubmissionRequest(String dataTransferNumber)
HttpRequest	createGetResultProtocolRequest(String dataTransferNumber)
String	getAccessToken()	For every request an access token is required
String	getDataTransferNumber()
BzstDipRequestStatusResult	readAndConfirmDataTransferNumbers()	Gets all data transfer numbers.
List<String>	requestResultLogs()	Retrieval of the results log
BzstDipSingleTransferResult	requestTransferResult(String dataTransferNumber)	Get the result protocol
String	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

DIP_MD

public static final String DIP_MD

See Also:

• Constant Field Values

PATCH

public static final String PATCH

See Also:

• Constant Field Values

OK_HTTP_STATUS_CODE

public static final int OK_HTTP_STATUS_CODE

See Also:

• Constant Field Values

Constructor Details

WebClient

public WebClient(BzstDipConfiguration configuration)

Method Details

getAccessToken

public String getAccessToken()
                      throws HttpStatusCodeNotExceptedException

For every request an access token is required

Returns:

Access Token as string

Throws:

HttpStatusCodeNotExceptedException

getDataTransferNumber

public String getDataTransferNumber()
                             throws HttpStatusCodeNotExceptedException

Returns:

XML as string with data transfer numbers

Throws:

HttpStatusCodeNotExceptedException

uploadMassData

public String uploadMassData(String dataTransferNumber,
 String xmlString)
                      throws HttpStatusCodeNotExceptedException

Throws:

HttpStatusCodeNotExceptedException

closeSubmission

public String closeSubmission(String dataTransferNumber)
                       throws HttpStatusCodeNotExceptedException

Requests the closing of the submission with the given dataTransferNumber.

Throws:

HttpStatusCodeNotExceptedException

requestResultLogs

public List<String> requestResultLogs()
                               throws HttpStatusCodeNotExceptedException,
IOException

Retrieval of the results log

Returns:

String list with data transfer numbers

Throws:

HttpStatusCodeNotExceptedException

IOException

createGetResultProtocolRequest

public HttpRequest createGetResultProtocolRequest(String dataTransferNumber)
                                           throws HttpStatusCodeNotExceptedException

Throws:

HttpStatusCodeNotExceptedException

requestTransferResult

public BzstDipSingleTransferResult requestTransferResult(String dataTransferNumber)
                                                  throws HttpStatusCodeNotExceptedException

Get the result protocol

Returns:

Returns complete HttpResponse

Throws:

HttpStatusCodeNotExceptedException

confirmTransfer

public BzstDipSingleTransferResult confirmTransfer(String transferNumber)
                                            throws HttpStatusCodeNotExceptedException

Confirm the result protocol

Throws:

HttpStatusCodeNotExceptedException

createAbortSubmissionRequest

public HttpRequest createAbortSubmissionRequest(String dataTransferNumber)
                                         throws HttpStatusCodeNotExceptedException

Throws:

HttpStatusCodeNotExceptedException

abortSubmission

public String abortSubmission(String dataTransferNumber)
                       throws HttpStatusCodeNotExceptedException

Throws:

HttpStatusCodeNotExceptedException

readAndConfirmDataTransferNumbers

public BzstDipRequestStatusResult readAndConfirmDataTransferNumbers()
                                                             throws HttpStatusCodeNotExceptedException,
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:

HttpStatusCodeNotExceptedException

IOException

close

public void close()

Specified by:

close in interface AutoCloseable