eu.peppol.outbound.client

Class AccessPointClient

java.lang.Object

eu.peppol.outbound.client.AccessPointClient

public final class AccessPointClient
extends Object

Utility class to access outbound services via http client.

Author:

senthilkumarn

Method Summary

Modifier and Type	Method and Description
static boolean	configureParticipantEmail(List<EmailDTO> emailDTOs) Configure participant email.
static boolean	configureParticipantEmail(List<EmailDTO> emailDTOs, String userName, String password) Configure participant email.
static boolean	createUser(UserDTO userCreationDTO) Creates the user.
static boolean	createUser(UserDTO userCreationDTO, String userName, String password) Creates the user.
static AccesspointDetails	getAccesspointDetails(String participantId) Get the access point details
static AccesspointDetails	getAccesspointDetails(String participantId, String userName, String password) Get the access point details
static List<ReceiptDTO>	getAllNewReceipts()
static List<ReceiptDTO>	getAllNewReceipts(String userName, String password) Get the recetly received receipt from the message reference
static AccesspointDetails	getEHFV3CreditNoteEndPoint(String participantId) Get the access point details if EHFV3 CreditNote is enabled
static AccesspointDetails	getEHFV3CreditNoteEndPoint(String participantId, String userName, String password) Get the access point details if EHFV3 CreditNote is enabled
static AccesspointDetails	getEHFV3InvoiceEndPoint(String participantId) Get the access point details if EHFV3 Invoice is enabled
static AccesspointDetails	getEHFV3InvoiceEndPoint(String participantId, String userName, String password) Get the access point details if EHFV3 Invoice is enabled
static AccesspointDetails	getEHFV3OrderEndPoint(String participantId, String userName, String password) Get the access point details if EHFV3 Order is enabled
static AccesspointDetails	getEHFV3OrderResponseEndPoint(String participantId, String userName, String password) Get the access point details if EHFV3 order response is enabled
static ReceiptDTO	getLastReceipt(String messageReference)
static ReceiptDTO	getLastReceipt(String messageReference, String userName, String password) Get the recetly received receipt from the message reference
static MessageDTO	getMessage(String messageId) Get Message
static MessageDTO	getMessage(String messageId, String userName, String password) Get Message
static MessageIdListDTO	getMessageId(Date syncDate) Get Message Id
static MessageIdListDTO	getMessageId(Date syncDate, String userName, String password) Get Message Id
static MessageIdListDTO	getMessageId(String participant) Get Message Id
static MessageIdListDTO	getMessageId(String participant, String userName, String password) Get Message Id
static String[]	getParticipantEmail(String participantId) Get participant email.
static String[]	getParticipantEmail(String participantId, String userName, String password) Configure participant email.
static List<ReceiptDTO>	getReceipt(String messageReference)
static List<ReceiptDTO>	getReceipt(String messageReference, String userName, String password) Get receipts
static MessageIdListDTO	getUnReadMessageIdForWeb() Get un Read Message Id for Web
static MessageIdListDTO	getUnReadMessageIdForWeb(String userName, String password) Get un Read Message Id for Web
static MessageIdListDTO	getUnReadMessageIdOfOrder(String participentId) Get un Read Message Id for Web
static MessageIdListDTO	getUnReadMessageIdOfOrder(String userName, String password, String participentId) Get un Read Message Id for Web
static MessageIdListDTO	getUnReadMessageIdOfOrderResponse(String participentId) Get un Read Message Id for Web
static MessageIdListDTO	getUnReadMessageIdOfOrderResponse(String userName, String password, String participentId) Get un Read Message Id for Web
static boolean	isParticipantEHFV3Enabled(String participantId) Return true if EHFV3 Invoice is enabled
static boolean	isParticipantEHFV3Enabled(String participantId, String userName, String password) Return true if EHFV3 Invoice is enabled
static boolean	isValidParticipant(String participant) Deprecated.
static boolean	isValidParticipant(String participant, EHFCustomizationID customizationID) Checks if is valid participant against the customizationID.
static boolean	isValidParticipant(String participant, String userName, String password) Deprecated.
static boolean	isValidParticipant(String participant, String userName, String password, EHFCustomizationID customizationID) Validates the participant for given profile ID
static boolean	markAsRead(List<String> messageIds) Mark as read.
static boolean	markAsRead(List<String> messageIds, String userName, String password) Mark message as read.
static boolean	markAsReadFromWeb(List<String> messageIds) Mark as read from web.
static boolean	markAsReadFromWeb(List<String> messageIds, String userName, String password) Mark message as read from web.
static boolean	markReceiptAsRead(List<String> receiptIds) Mark receipt as read.
static boolean	markReceiptAsRead(List<String> receiptIds, String userName, String password) Mark receipt as read.
static MessageListDTO	receiveInvoice(Date syncDate) Deprecated.
static MessageListDTO	receiveInvoice(Date syncDate, String userName, String password) Deprecated.
static MessageListDTO	receiveInvoice(String participant) Deprecated.
static MessageListDTO	receiveInvoice(String participant, String userName, String password) Deprecated.
static boolean	removeMessage(MessageRemoverDTO msgRemoverDTO) Removes the message.
static boolean	removeMessage(MessageRemoverDTO msgRemoverDTO, String userName, String password) Removes the message of a participant.
static String	sendEHFV3Order(DocumentDTO documentDTO) Send order.
static String	sendEHFV3Order(DocumentDTO documentDTO, String userName, String password) Send order.
static String	sendEHFV3OrderResponse(DocumentDTO documentDTO)
static String	sendEHFV3OrderResponse(DocumentDTO documentDTO, String userName, String password)
static String	sendInvoice(DocumentDTO documentDTO) Deprecated. it is recommended to use enhanced peppol function to transmit documents.
static String	sendInvoice(DocumentDTO documentDTO, String userName, String password) Deprecated. it is recommended to use enhanced peppol function to transmit documents.
static String	sendOrder(DocumentDTO documentDTO) Send order.
static String	sendOrder(DocumentDTO documentDTO, String userName, String password) Send order.
static String	sendOrderResponse(DocumentDTO documentDTO)
static String	sendOrderResponse(DocumentDTO documentDTO, String userName, String password)
static String	sendReceipts(DocumentDTO documentDTO)
static String	sendReceipts(DocumentDTO documentDTO, String userName, String password) For sending Enhanced PEPPOL receipt documents.
static void	setClientUrl(String url)

Methods inherited from class java.lang.Object

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

Method Detail

setClientUrl

public static void setClientUrl(String url)

sendInvoice

@Deprecated
public static String sendInvoice(DocumentDTO documentDTO,
                                              String userName,
                                              String password)
                                       throws Exception

Deprecated. it is recommended to use enhanced peppol function to transmit documents.

Send invoice.

Parameters:

documentDTO - the document dto

userName - the user name

password - the password

Returns:

the string message id

Throws:

Exception - the exception

sendInvoice

@Deprecated
public static String sendInvoice(DocumentDTO documentDTO)
                                       throws Exception

Deprecated. it is recommended to use enhanced peppol function to transmit documents.

Send invoice.

Parameters:

documentDTO - the document dto

Returns:

the string

Throws:

Exception - the exception

receiveInvoice

@Deprecated
public static MessageListDTO receiveInvoice(Date syncDate,
                                                         String userName,
                                                         String password)
                                                  throws Exception

Deprecated.

Receive invoices based on the date.

Parameters:

syncDate - the sync date

userName - the user name

password - the password

Returns:

the list

Throws:

Exception - the exception

receiveInvoice

@Deprecated
public static MessageListDTO receiveInvoice(Date syncDate)
                                                  throws Exception

Deprecated.

Receive invoice.

Parameters:

syncDate - the sync date

Returns:

the message list dto

Throws:

Exception - the exception

receiveInvoice

@Deprecated
public static MessageListDTO receiveInvoice(String participant,
                                                         String userName,
                                                         String password)
                                                  throws Exception

Deprecated.

Receive invoices based on the participant.

Parameters:

participant - the participant

userName - the user name

password - the password

Returns:

the list

Throws:

Exception - the exception

receiveInvoice

@Deprecated
public static MessageListDTO receiveInvoice(String participant)
                                                  throws Exception

Deprecated.

Receive invoice.

Parameters:

participant - the participant

Returns:

the message list dto

Throws:

Exception - the exception

getMessage

public static MessageDTO getMessage(String messageId,
                                    String userName,
                                    String password)
                             throws Exception

Get Message

Parameters:

messageId -

userName -

password -

Returns:

Throws:

Exception

getMessage

public static MessageDTO getMessage(String messageId)
                             throws Exception

Get Message

Parameters:

messageId -

Returns:

Throws:

Exception

getMessageId

public static MessageIdListDTO getMessageId(String participant,
                                            String userName,
                                            String password)
                                     throws Exception

Get Message Id

Parameters:

participant -

userName -

password -

Returns:

Throws:

Exception

getMessageId

public static MessageIdListDTO getMessageId(String participant)
                                     throws Exception

Get Message Id

Parameters:

participant -

Returns:

Throws:

Exception

getMessageId

public static MessageIdListDTO getMessageId(Date syncDate,
                                            String userName,
                                            String password)
                                     throws Exception

Get Message Id

Parameters:

syncDate -

userName -

password -

Returns:

Throws:

Exception

getUnReadMessageIdForWeb

public static MessageIdListDTO getUnReadMessageIdForWeb(String userName,
                                                        String password)
                                                 throws Exception

Get un Read Message Id for Web

Parameters:

syncDate -

userName -

password -

Returns:

Throws:

Exception

getUnReadMessageIdForWeb

public static MessageIdListDTO getUnReadMessageIdForWeb()
                                                 throws Exception

Get un Read Message Id for Web

Returns:

MessageIdListDTO

Throws:

Exception

getMessageId

public static MessageIdListDTO getMessageId(Date syncDate)
                                     throws Exception

Get Message Id

Parameters:

syncDate -

Returns:

Throws:

Exception

removeMessage

public static boolean removeMessage(MessageRemoverDTO msgRemoverDTO,
                                    String userName,
                                    String password)
                             throws Exception

Removes the message of a participant.

Parameters:

msgRemoverDTO - the msg remover dto

userName - the user name

password - the password

Returns:

true, if successful

Throws:

Exception - the exception

removeMessage

public static boolean removeMessage(MessageRemoverDTO msgRemoverDTO)
                             throws Exception

Removes the message.

Parameters:

msgRemoverDTO - the msg remover dto

Returns:

true, if successful

Throws:

Exception - the exception

isValidParticipant

public static boolean isValidParticipant(String participant,
                                         String userName,
                                         String password,
                                         EHFCustomizationID customizationID)
                                  throws Exception

Validates the participant for given profile ID

Parameters:

participant - the participant

userName - the user name

password - the password

Returns:

true, if is valid participant

Throws:

Exception - the exception

isValidParticipant

@Deprecated
public static boolean isValidParticipant(String participant,
                                                      String userName,
                                                      String password)
                                               throws Exception

Deprecated.

Checks for valid participant. This method is depricated as the validation happens only for EHF invoice(1.6 and 2.0) Validation does not happen for CreditNote and Order. Instead use "isValidParticipant(String participant, String userName, String password, EHFCustomizationID customizationID)"

Parameters:

participant - the participant

userName - the user name

password - the password

Returns:

true, if is valid participant

Throws:

Exception - the exception

isValidParticipant

@Deprecated
public static boolean isValidParticipant(String participant)
                                               throws Exception

Deprecated.

Checks for valid participant. This method is depricated as the validation happens only for EHF invoice(1.6 and 2.0) Validation does not happen for CreditNote and Order. Instead use "isValidParticipant(String participant, EHFCustomizationID customizationID)"

Parameters:

participant - the participant

Returns:

true, if is valid participant

Throws:

Exception - the exception

isValidParticipant

public static boolean isValidParticipant(String participant,
                                         EHFCustomizationID customizationID)
                                  throws Exception

Checks if is valid participant against the customizationID.

Parameters:

participant - the participant

Returns:

true, if is valid participant

Throws:

Exception - the exception

markAsRead

public static boolean markAsRead(List<String> messageIds,
                                 String userName,
                                 String password)
                          throws Exception

Mark message as read.

Parameters:

messageIds - the message ids

userName - the user name

password - the password

Returns:

true, if successful

Throws:

Exception - the exception

markAsRead

public static boolean markAsRead(List<String> messageIds)
                          throws Exception

Mark as read.

Parameters:

messageIds - the message ids

Returns:

true, if successful

Throws:

Exception - the exception

markAsReadFromWeb

public static boolean markAsReadFromWeb(List<String> messageIds,
                                        String userName,
                                        String password)
                                 throws Exception

Mark message as read from web.

Parameters:

messageIds - the message ids

userName - the user name

password - the password

Returns:

true, if successful

Throws:

Exception - the exception

markAsReadFromWeb

public static boolean markAsReadFromWeb(List<String> messageIds)
                                 throws Exception

Mark as read from web.

Parameters:

messageIds - the message ids

Returns:

true, if successful

Throws:

Exception - the exception

configureParticipantEmail

public static boolean configureParticipantEmail(List<EmailDTO> emailDTOs,
                                                String userName,
                                                String password)
                                         throws Exception

Configure participant email.

Parameters:

emailDTOs - the email dtos

userName - the user name

password - the password

Returns:

true, if successful

Throws:

Exception - the exception

configureParticipantEmail

public static boolean configureParticipantEmail(List<EmailDTO> emailDTOs)
                                         throws Exception

Configure participant email.

Parameters:

emailDTOs - the email dt os

Returns:

true, if successful

Throws:

Exception - the exception

getParticipantEmail

public static String[] getParticipantEmail(String participantId,
                                           String userName,
                                           String password)
                                    throws Exception

Configure participant email.

Parameters:

participantId - the participant Id

userName - the user name

password - the password

Returns:

the participant string[]

Throws:

Exception - the exception

getAccesspointDetails

public static AccesspointDetails getAccesspointDetails(String participantId)
                                                throws Exception

Get the access point details

Parameters:

participantId -

Returns:

the AccesspointDetails

Throws:

Exception

getAccesspointDetails

public static AccesspointDetails getAccesspointDetails(String participantId,
                                                       String userName,
                                                       String password)
                                                throws Exception

Get the access point details

Parameters:

participantId -

userName -

password -

Returns:

the AccesspointDetails

Throws:

Exception

isParticipantEHFV3Enabled

public static boolean isParticipantEHFV3Enabled(String participantId)
                                         throws Exception

Return true if EHFV3 Invoice is enabled

Parameters:

participantId -

Returns:

the boolean

Throws:

Exception

isParticipantEHFV3Enabled

public static boolean isParticipantEHFV3Enabled(String participantId,
                                                String userName,
                                                String password)
                                         throws Exception

Return true if EHFV3 Invoice is enabled

Parameters:

participantId -

userName -

password -

Returns:

the boolean

Throws:

Exception

getEHFV3InvoiceEndPoint

public static AccesspointDetails getEHFV3InvoiceEndPoint(String participantId)
                                                  throws Exception

Get the access point details if EHFV3 Invoice is enabled

Parameters:

participantId -

Returns:

the AccesspointDetails

Throws:

Exception

getEHFV3InvoiceEndPoint

public static AccesspointDetails getEHFV3InvoiceEndPoint(String participantId,
                                                         String userName,
                                                         String password)
                                                  throws Exception

Get the access point details if EHFV3 Invoice is enabled

Parameters:

participantId -

userName -

password -

Returns:

the AccesspointDetails

Throws:

Exception

getEHFV3CreditNoteEndPoint

public static AccesspointDetails getEHFV3CreditNoteEndPoint(String participantId)
                                                     throws Exception

Get the access point details if EHFV3 CreditNote is enabled

Parameters:

participantId -

Returns:

the AccesspointDetails

Throws:

Exception

getEHFV3CreditNoteEndPoint

public static AccesspointDetails getEHFV3CreditNoteEndPoint(String participantId,
                                                            String userName,
                                                            String password)
                                                     throws Exception

Get the access point details if EHFV3 CreditNote is enabled

Parameters:

participantId -

userName -

password -

Returns:

the AccesspointDetails

Throws:

Exception

getParticipantEmail

public static String[] getParticipantEmail(String participantId)
                                    throws Exception

Get participant email.

Parameters:

participantId - the participant Id

Returns:

the participant string[]

Throws:

Exception - the exception

createUser

public static boolean createUser(UserDTO userCreationDTO)
                          throws Exception

Creates the user.

Parameters:

userCreationDTO - the user creation dto

Returns:

true, if successful

Throws:

Exception - the exception

createUser

public static boolean createUser(UserDTO userCreationDTO,
                                 String userName,
                                 String password)
                          throws Exception

Creates the user.

Parameters:

userCreationDTO - the user creation dto

userName - the user name

password - the password

Returns:

true, if successful

Throws:

Exception - the exception

sendOrder

public static String sendOrder(DocumentDTO documentDTO)
                        throws Exception

Send order.

Parameters:

documentDTO - the document dto

Returns:

the string

Throws:

Exception - the exception

sendOrder

public static String sendOrder(DocumentDTO documentDTO,
                               String userName,
                               String password)
                        throws Exception

Send order.

Parameters:

documentDTO - the document dto

userName - the user name

password - the password

Returns:

the string

Throws:

Exception - the exception

sendOrderResponse

public static String sendOrderResponse(DocumentDTO documentDTO)
                                throws Exception

Throws:

Exception

sendOrderResponse

public static String sendOrderResponse(DocumentDTO documentDTO,
                                       String userName,
                                       String password)
                                throws Exception

Throws:

Exception

sendReceipts

public static String sendReceipts(DocumentDTO documentDTO,
                                  String userName,
                                  String password)
                           throws Exception

For sending Enhanced PEPPOL receipt documents.

Parameters:

documentDTO - the document dto

userName - the user name

password - the password

Returns:

message reference

Throws:

Exception - the exception

sendReceipts

public static String sendReceipts(DocumentDTO documentDTO)
                           throws Exception

Throws:

Exception

getReceipt

public static List<ReceiptDTO> getReceipt(String messageReference,
                                          String userName,
                                          String password)
                                   throws Exception

Get receipts

Parameters:

messageId -

userName -

password -

Returns:

Throws:

Exception

getReceipt

public static List<ReceiptDTO> getReceipt(String messageReference)
                                   throws Exception

Throws:

Exception

getLastReceipt

public static ReceiptDTO getLastReceipt(String messageReference,
                                        String userName,
                                        String password)
                                 throws Exception

Get the recetly received receipt from the message reference

Parameters:

messageId -

userName -

password -

Returns:

Throws:

Exception

getLastReceipt

public static ReceiptDTO getLastReceipt(String messageReference)
                                 throws Exception

Throws:

Exception

getAllNewReceipts

public static List<ReceiptDTO> getAllNewReceipts(String userName,
                                                 String password)
                                          throws Exception

Get the recetly received receipt from the message reference

Parameters:

messageId -

userName -

password -

Returns:

Throws:

Exception

getAllNewReceipts

public static List<ReceiptDTO> getAllNewReceipts()
                                          throws Exception

Throws:

Exception

markReceiptAsRead

public static boolean markReceiptAsRead(List<String> receiptIds,
                                        String userName,
                                        String password)
                                 throws Exception

Mark receipt as read.

Parameters:

receiptIds - the receipt ids

userName - the user name

password - the password

Returns:

true, if successful

Throws:

Exception - the exception

markReceiptAsRead

public static boolean markReceiptAsRead(List<String> receiptIds)
                                 throws Exception

Mark receipt as read.

Parameters:

receiptIds - the receipt ids

Returns:

true, if successful

Throws:

Exception - the exception

getUnReadMessageIdOfOrder

public static MessageIdListDTO getUnReadMessageIdOfOrder(String userName,
                                                         String password,
                                                         String participentId)
                                                  throws Exception

Get un Read Message Id for Web

Parameters:

syncDate -

userName -

password -

Returns:

Throws:

Exception

getUnReadMessageIdOfOrder

public static MessageIdListDTO getUnReadMessageIdOfOrder(String participentId)
                                                  throws Exception

Get un Read Message Id for Web

Parameters:

participentId - receiver participent id if null returns messages of all receiver

Returns:

MessageIdListDTO

Throws:

Exception

getUnReadMessageIdOfOrderResponse

public static MessageIdListDTO getUnReadMessageIdOfOrderResponse(String userName,
                                                                 String password,
                                                                 String participentId)
                                                          throws Exception

Get un Read Message Id for Web

Parameters:

syncDate -

userName -

password -

Returns:

Throws:

Exception

getUnReadMessageIdOfOrderResponse

public static MessageIdListDTO getUnReadMessageIdOfOrderResponse(String participentId)
                                                          throws Exception

Get un Read Message Id for Web

Parameters:

participentId - receiver participent id if null returns messages of all receiver

Returns:

MessageIdListDTO

Throws:

Exception

getEHFV3OrderEndPoint

public static AccesspointDetails getEHFV3OrderEndPoint(String participantId,
                                                       String userName,
                                                       String password)
                                                throws Exception

Get the access point details if EHFV3 Order is enabled

Parameters:

participantId -

userName -

password -

Returns:

Throws:

Exception

getEHFV3OrderResponseEndPoint

public static AccesspointDetails getEHFV3OrderResponseEndPoint(String participantId,
                                                               String userName,
                                                               String password)
                                                        throws Exception

Get the access point details if EHFV3 order response is enabled

Parameters:

participantId -

userName -

password -

Returns:

the AccesspointDetails

Throws:

Exception

sendEHFV3Order

public static String sendEHFV3Order(DocumentDTO documentDTO)
                             throws Exception

Send order.

Parameters:

documentDTO - the document dto

Returns:

the string

Throws:

Exception - the exception

sendEHFV3Order

public static String sendEHFV3Order(DocumentDTO documentDTO,
                                    String userName,
                                    String password)
                             throws Exception

Send order.

Parameters:

documentDTO - the document dto

userName - the user name

password - the password

Returns:

the string

Throws:

Exception - the exception

sendEHFV3OrderResponse

public static String sendEHFV3OrderResponse(DocumentDTO documentDTO)
                                     throws Exception

Throws:

Exception

sendEHFV3OrderResponse

public static String sendEHFV3OrderResponse(DocumentDTO documentDTO,
                                            String userName,
                                            String password)
                                     throws Exception

Throws:

Exception