net.dreceiptx.client

Class DRXClient

java.lang.Object

net.dreceiptx.client.DRXClient

All Implemented Interfaces:

ExchangeClient

public class DRXClient
extends java.lang.Object
implements ExchangeClient

Constructor Summary

Constructors

Constructor and Description
DRXClient() Creates basic instance of ExchangeClient
DRXClient(ConfigManager configManager) Creates instance of ExchangeClient using the given ConfigManager
DRXClient(ExchangeCredentials credentials) Creates instance of DRXClient using the given ExchangeCredentials.
DRXClient(Region region) Creates instance of ExchangeClient using the given Region.
DRXClient(Region region, ExchangeCredentials credentials) Creates instance of ExchangeClient using the given Region and with provided ExchangeCredentials

Method Summary

Modifier and Type	Method and Description
boolean	downloadReceiptPDF(java.lang.String receiptId)
java.lang.String	getDirectoryHost()
java.lang.String	getExchangeAPIHost()
ExchangeCredentials	getExchangeCredentials()
java.lang.String	getReceiptVersion()
java.lang.String	getUserVersion()
Merchant	lookupMerchant(java.lang.String Id)
DigitalReceipt	lookupReceipt(java.lang.String receiptId)
java.util.Map<java.lang.String,NewUserRegistrationResult>	registerNewUser(java.util.List<NewUser> newUsers)
NewUserRegistrationResult	registerNewUser(NewUser newUser)
User	searchUser(UserIdentifierType identifierType, java.lang.String identifier)
Users	searchUsers(UserIdentifierType identifierType, java.util.ArrayList<java.lang.String> userIdentifiers)
java.lang.String	sendDryRunReceipt(ReceiptPostRequest receiptPostRequest)
java.lang.String	sendProductionReceipt(ReceiptPostRequest receiptPostRequest)

Methods inherited from class java.lang.Object

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

Constructor Detail

DRXClient

public DRXClient()
          throws ExchangeClientException

Creates basic instance of ExchangeClient

Throws:

ExchangeClientException

DRXClient

public DRXClient(Region region)
          throws ExchangeClientException

Creates instance of ExchangeClient using the given Region. The region will be used as a template for the endpoint locations for the DRXClient instance, this can be overridden on a per receipt basis by setting the region on the Location object on the receipt.

Parameters:

region - the Region settings to be used by the ExchangeClient

Throws:

ExchangeClientException

DRXClient

public DRXClient(ExchangeCredentials credentials)
          throws ExchangeClientException

Creates instance of DRXClient using the given ExchangeCredentials. These credentials will be used when sending a receipt to the exchange. If the credentials are null or the properties on the credentials are null then ExchangeClientException will be thrown.

Parameters:

credentials - The credentials to be used when sending a receipt to the exchange

Throws:

ExchangeClientException

DRXClient

public DRXClient(Region region,
                 ExchangeCredentials credentials)
          throws ExchangeClientException

Creates instance of ExchangeClient using the given Region and with provided ExchangeCredentials

Parameters:

region - the Region settings to be used by the ExchangeClient

credentials - the ExchangeCredentials settings to be used by the ExchangeClient

Throws:

ExchangeClientException

DRXClient

public DRXClient(ConfigManager configManager)
          throws ExchangeClientException

Creates instance of ExchangeClient using the given ConfigManager

Parameters:

configManager - the ConfigManager to be used by the ExchangeClient

Throws:

ExchangeClientException - will be thrown of configManager contains invalid configuration

Method Detail

getExchangeCredentials

public ExchangeCredentials getExchangeCredentials()

getExchangeAPIHost

public java.lang.String getExchangeAPIHost()

getReceiptVersion

public java.lang.String getReceiptVersion()

getDirectoryHost

public java.lang.String getDirectoryHost()

getUserVersion

public java.lang.String getUserVersion()

sendProductionReceipt

public java.lang.String sendProductionReceipt(ReceiptPostRequest receiptPostRequest)
                                       throws ExchangeClientException

Specified by:

sendProductionReceipt in interface ExchangeClient

Parameters:

receiptPostRequest - ReceiptPostRequest

Returns:

transactionId

Throws:

ExchangeClientException - will be thrown if problem calling the service.

sendDryRunReceipt

public java.lang.String sendDryRunReceipt(ReceiptPostRequest receiptPostRequest)
                                   throws ExchangeClientException

Specified by:

sendDryRunReceipt in interface ExchangeClient

Parameters:

receiptPostRequest - ReceiptPostRequest

Returns:

transactionId

Throws:

ExchangeClientException - will be thrown if problem calling the service.

searchUser

public User searchUser(UserIdentifierType identifierType,
                       java.lang.String identifier)
                throws ExchangeClientException

Specified by:

searchUser in interface ExchangeClient

Parameters:

identifierType - UserIdentifierType

identifier - String

Returns:

The matching users will be returned if it is found otherwise null

Throws:

ExchangeClientException - will be thrown if problem calling the service.

searchUsers

public Users searchUsers(UserIdentifierType identifierType,
                         java.util.ArrayList<java.lang.String> userIdentifiers)
                  throws ExchangeClientException

Specified by:

searchUsers in interface ExchangeClient

Parameters:

identifierType - UserIdentifierType

userIdentifiers - list of user identifiers

Returns:

The matching users will be returned if it is found otherwise null

Throws:

ExchangeClientException - will be thrown if problem calling the service.

lookupReceipt

public DigitalReceipt lookupReceipt(java.lang.String receiptId)
                             throws ExchangeClientException

Specified by:

lookupReceipt in interface ExchangeClient

Parameters:

receiptId - String

Returns:

DigitalReceipt

Throws:

ExchangeClientException - will be thrown if problem calling the service.

downloadReceiptPDF

public boolean downloadReceiptPDF(java.lang.String receiptId)
                           throws ExchangeClientException

Specified by:

downloadReceiptPDF in interface ExchangeClient

Parameters:

receiptId - String

Returns:

boolean

Throws:

ExchangeClientException - will be thrown if problem calling the service.

registerNewUser

public NewUserRegistrationResult registerNewUser(NewUser newUser)
                                          throws ExchangeClientException

Specified by:

registerNewUser in interface ExchangeClient

Parameters:

newUser - NewUser

Returns:

newUserRegistrationResult

Throws:

ExchangeClientException - will be thrown if problem calling the service.

registerNewUser

public java.util.Map<java.lang.String,NewUserRegistrationResult> registerNewUser(java.util.List<NewUser> newUsers)
                                                                          throws ExchangeClientException

Specified by:

registerNewUser in interface ExchangeClient

Parameters:

newUsers - list of users to be registered

Returns:

map of userid to NewUserRegistrationResult

Throws:

ExchangeClientException - will be thrown if problem calling the service.

lookupMerchant

public Merchant lookupMerchant(java.lang.String Id)
                        throws ExchangeClientException

Specified by:

lookupMerchant in interface ExchangeClient

Parameters:

Id - String

Returns:

Merchant

Throws:

ExchangeClientException - will be thrown if problem calling the service.