com.helger.peppol.smpclient

Class SMPClient

java.lang.Object

com.helger.peppol.httpclient.AbstractGenericSMPClient<SMPClientReadOnly>

com.helger.peppol.smpclient.SMPClientReadOnly

com.helger.peppol.smpclient.SMPClient

All Implemented Interfaces:

com.helger.commons.traits.IGenericImplTrait<SMPClientReadOnly>

public class SMPClient
extends SMPClientReadOnly

This class is used for calling the SMP REST interface. This particular class contains the writing methods. It inherits all reading methods from SMPClientReadOnly.

Author:

PEPPOL.AT, BRZ, Philip Helger

Constructor Summary

Constructors

Constructor and Description
SMPClient(com.helger.peppol.url.IPeppolURLProvider aURLProvider, com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantIdentifier, com.helger.peppol.sml.ISMLInfo aSMLInfo) Constructor with SML lookup
SMPClient(com.helger.peppol.url.IPeppolURLProvider aURLProvider, com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantIdentifier, String sSMLZoneName) Constructor with SML lookup
SMPClient(URI aSMPHost) Constructor with a direct SMP URL.

Method Summary

Modifier and Type	Method and Description
void	deleteServiceGroup(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID, com.helger.http.basicauth.BasicAuthClientCredentials aCredentials) Deletes a service group given by its service group id.
void	deleteServiceRegistration(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID, com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID, com.helger.http.basicauth.BasicAuthClientCredentials aCredentials) Deletes a service meta data object given by its service group id and its document type.
com.helger.peppol.smp.ServiceGroupType	saveServiceGroup(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantID, com.helger.http.basicauth.BasicAuthClientCredentials aCredentials) Saves a service group.
void	saveServiceGroup(com.helger.peppol.smp.ServiceGroupType aServiceGroup, com.helger.http.basicauth.BasicAuthClientCredentials aCredentials) Saves a service group.
void	saveServiceInformation(com.helger.peppol.smp.ServiceInformationType aServiceInformation, com.helger.http.basicauth.BasicAuthClientCredentials aCredentials) Saves a service information data object.
void	saveServiceRedirect(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID, com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID, com.helger.peppol.smp.RedirectType aRedirect, com.helger.http.basicauth.BasicAuthClientCredentials aCredentials) Saves a redirect data object.
void	saveServiceRegistration(com.helger.peppol.smp.ServiceMetadataType aServiceMetadata, com.helger.http.basicauth.BasicAuthClientCredentials aCredentials) Deprecated.

Methods inherited from class com.helger.peppol.smpclient.SMPClientReadOnly

getCompleteServiceGroup, getCompleteServiceGroup, getCompleteServiceGroupByDNS, getCompleteServiceGroupOrNull, getEndpoint, getEndpoint, getEndpointAddress, getEndpointAddress, getEndpointCertificate, getEndpointCertificate, getEndpointCertificateString, getEndpointCertificateString, getServiceGroup, getServiceGroupByDNS, getServiceGroupOrNull, getServiceGroupReferenceList, getServiceGroupReferenceListOrNull, getServiceRegistration, getServiceRegistrationByDNS, getServiceRegistrationOrNull

Methods inherited from class com.helger.peppol.httpclient.AbstractGenericSMPClient

createHttpContext, executeGenericRequest, executeRequest, getConnectionTimeoutMS, getConvertedException, getProxy, getProxyCredentials, getRequestTimeoutMS, getSMPHostURI, isCheckCertificate, isUseDNSClientCache, isUseProxySystemProperties, setCheckCertificate, setConnectionTimeoutMS, setProxy, setProxyCredentials, setRequestTimeoutMS, setUseDNSClientCache, setUseProxySystemProperties, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Constructor Detail

SMPClient

public SMPClient(@Nonnull
                 com.helger.peppol.url.IPeppolURLProvider aURLProvider,
                 @Nonnull
                 com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantIdentifier,
                 @Nonnull
                 com.helger.peppol.sml.ISMLInfo aSMLInfo)

Constructor with SML lookup

Parameters:

aURLProvider - The URL provider to be used. May not be null.

aParticipantIdentifier - The participant identifier to be used. Required to build the SMP access URI.

aSMLInfo - The SML to be used. Required to build the SMP access URI.

See Also:

IPeppolURLProvider.getSMPURIOfParticipant(IParticipantIdentifier, ISMLInfo)

SMPClient

public SMPClient(@Nonnull
                 com.helger.peppol.url.IPeppolURLProvider aURLProvider,
                 @Nonnull
                 com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantIdentifier,
                 @Nonnull @Nonempty
                 String sSMLZoneName)

Constructor with SML lookup

Parameters:

aURLProvider - The URL provider to be used. May not be null.

aParticipantIdentifier - The participant identifier to be used. Required to build the SMP access URI.

sSMLZoneName - The SML DNS zone name to be used. Required to build the SMP access URI. Must end with a trailing dot (".") and may neither be null nor empty to build a correct URL. May not start with "http://". Example: sml.peppolcentral.org.

See Also:

IPeppolURLProvider.getSMPURIOfParticipant(IParticipantIdentifier, String)

SMPClient

public SMPClient(@Nonnull
                 URI aSMPHost)

Constructor with a direct SMP URL.
Remember: must be HTTP and using port 80 only!

Parameters:

aSMPHost - The address of the SMP service. Must be port 80 and basic http only (no https!). Example: http://smpcompany.company.org

Method Detail

saveServiceGroup

public void saveServiceGroup(@Nonnull
                             com.helger.peppol.smp.ServiceGroupType aServiceGroup,
                             @Nonnull
                             com.helger.http.basicauth.BasicAuthClientCredentials aCredentials)
                      throws SMPClientException

Saves a service group. The meta data references should not be set and are not used.

Parameters:

aServiceGroup - The service group to save.

aCredentials - The user name and password to use as aCredentials.

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - The user name or password was not correct.

SMPClientNotFoundException - A HTTP Not Found was received. This can happen if the service was not found.

SMPClientBadRequestException - The request was not well formed.

saveServiceGroup

@Nonnull
public com.helger.peppol.smp.ServiceGroupType saveServiceGroup(@Nonnull
                                                                         com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantID,
                                                                         @Nonnull
                                                                         com.helger.http.basicauth.BasicAuthClientCredentials aCredentials)
                                                                  throws SMPClientException

Saves a service group. The meta data references should not be set and are not used.

Parameters:

aParticipantID - The participant identifier for which the service group is to save.

aCredentials - The user name and password to use as credentials.

Returns:

The created ServiceGroupType object.

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - The user name or password was not correct.

SMPClientNotFoundException - A HTTP Not Found was received. This can happen if the service was not found.

SMPClientBadRequestException - The request was not well formed.

deleteServiceGroup

public void deleteServiceGroup(@Nonnull
                               com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID,
                               @Nonnull
                               com.helger.http.basicauth.BasicAuthClientCredentials aCredentials)
                        throws SMPClientException

Deletes a service group given by its service group id.

Parameters:

aServiceGroupID - The service group id of the service group to delete.

aCredentials - The user name and password to use as aCredentials.

Throws:

SMPClientException - in case something goes wrong

SMPClientNotFoundException - The service group id did not exist.

SMPClientUnauthorizedException - The user name or password was not correct.

SMPClientBadRequestException - The request was not well formed.

saveServiceRegistration

@Deprecated
public void saveServiceRegistration(@Nonnull
                                                 com.helger.peppol.smp.ServiceMetadataType aServiceMetadata,
                                                 @Nonnull
                                                 com.helger.http.basicauth.BasicAuthClientCredentials aCredentials)
                                          throws SMPClientException

Deprecated.

Saves a service meta data object. This method can only used to save service information objects!

Parameters:

aServiceMetadata - The service meta data object to save.

aCredentials - The user name and password to use as aCredentials.

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - The user name or password was not correct.

SMPClientNotFoundException - A HTTP Not Found was received. This can happen if the service was not found.

SMPClientBadRequestException - The request was not well formed.

See Also:

saveServiceInformation(ServiceInformationType, BasicAuthClientCredentials), saveServiceRedirect(IParticipantIdentifier, IDocumentTypeIdentifier, RedirectType, BasicAuthClientCredentials)

saveServiceInformation

public void saveServiceInformation(@Nonnull
                                   com.helger.peppol.smp.ServiceInformationType aServiceInformation,
                                   @Nonnull
                                   com.helger.http.basicauth.BasicAuthClientCredentials aCredentials)
                            throws SMPClientException

Saves a service information data object.

Parameters:

aServiceInformation - The service information object to save.

aCredentials - The user name and password to use as aCredentials.

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - The user name or password was not correct.

SMPClientNotFoundException - A HTTP Not Found was received. This can happen if the service was not found.

SMPClientBadRequestException - The request was not well formed.

See Also:

saveServiceRedirect(IParticipantIdentifier, IDocumentTypeIdentifier, RedirectType, BasicAuthClientCredentials)

saveServiceRedirect

public void saveServiceRedirect(@Nonnull
                                com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID,
                                @Nonnull
                                com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID,
                                @Nonnull
                                com.helger.peppol.smp.RedirectType aRedirect,
                                @Nonnull
                                com.helger.http.basicauth.BasicAuthClientCredentials aCredentials)
                         throws SMPClientException

Saves a redirect data object.

Parameters:

aServiceGroupID - The service group ID to use. May not be null.

aDocumentTypeID - The document type ID to use. May not be null.

aRedirect - The redirect to be saved. May not be null.

aCredentials - The user name and password to use as aCredentials.

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - The user name or password was not correct.

SMPClientNotFoundException - A HTTP Not Found was received. This can happen if the service was not found.

SMPClientBadRequestException - The request was not well formed.

See Also:

saveServiceInformation(ServiceInformationType, BasicAuthClientCredentials)

deleteServiceRegistration

public void deleteServiceRegistration(@Nonnull
                                      com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID,
                                      @Nonnull
                                      com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID,
                                      @Nonnull
                                      com.helger.http.basicauth.BasicAuthClientCredentials aCredentials)
                               throws SMPClientException

Deletes a service meta data object given by its service group id and its document type.

Parameters:

aServiceGroupID - The service group id of the service meta data to delete.

aDocumentTypeID - The document type of the service meta data to delete.

aCredentials - The user name and password to use as aCredentials.

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - The user name or password was not correct.

SMPClientNotFoundException - The service meta data object did not exist.

SMPClientBadRequestException - The request was not well formed.