com.helger.peppol.smlclient

Class BDMSLClient

java.lang.Object

com.helger.wsclient.WSClientConfig

com.helger.peppol.smlclient.BDMSLClient

public class BDMSLClient
extends com.helger.wsclient.WSClientConfig

A client for the new BDMSL specific "BDMSL service"

Note: this class is also licensed under Apache 2 license, as it was not part of the original implementation

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.wsclient.WSClientConfig

DEFAULT_CHUNK_SIZE, DEFAULT_CONNECTION_TIMEOUT_MS, DEFAULT_REQUEST_TIMEOUT_MS

Constructor Summary

Constructors

Constructor and Description
BDMSLClient(com.helger.peppol.sml.ISMLInfo aSMLInfo)
BDMSLClient(URL aEndpointAddress) Constructs a service caller for the manage business identifier interface.

Method Summary

Modifier and Type	Method and Description
void	changeCertificate(String sSMPID, byte[] aNewCertificatePublicKey) Change a certificate
void	clearCache()
void	createParticipantIdentifier(String sSMPID, com.helger.peppolid.IParticipantIdentifier aParticipantID, String sServiceName)
protected BDMSLServiceSoap	createWSPort() Create the main WebService client for the specified endpoint address.
boolean	isAlive()
com.helger.commons.collection.impl.ICommonsList<ParticipantListItem>	listParticipants()
void	prepareChangeCertificate(String sNewCertificatePublicKey, LocalDate aMigrationDate) This operation allows a SMP to prepare a change of its certificate.

Methods inherited from class com.helger.wsclient.WSClientConfig

applyWSSettingsToBindingProvider, customizeRequestContext, getChunkSize, getConnectionTimeoutMS, getEndpointAddress, getHostnameVerifier, getPassword, getRequestTimeoutMS, getSOAPAction, getSSLSocketFactory, getUserName, handlers, hasChunkSize, hasConnectionTimeoutMS, hasPassword, hasRequestTimeoutMS, hasSOAPAction, hasUserName, httpHeaders, isCookiesSupportEnabled, isWorkAroundMASM0003, setChunkSize, setCompressedRequest, setCompressedResponse, setConnectionTimeoutMS, setCookiesSupportEnabled, setHostnameVerifier, setHostnameVerifierTrustAll, setHostnameVerifierTrustAll, setPassword, setRequestTimeoutMS, setSOAPAction, setSSLSocketFactory, setSSLSocketFactoryTrustAll, setSSLSocketFactoryTrustAll, setUserName, setWorkAroundMASM0003

Methods inherited from class java.lang.Object

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

Constructor Detail

BDMSLClient

public BDMSLClient(@Nonnull
                   com.helger.peppol.sml.ISMLInfo aSMLInfo)

BDMSLClient

public BDMSLClient(@Nonnull
                   URL aEndpointAddress)

Constructs a service caller for the manage business identifier interface.
Example of a host:
https://sml.peppolcentral.org/cipaservice

Parameters:

aEndpointAddress - The URL of the CIPA Service interface. May not be null.

Method Detail

createWSPort

@Nonnull
 @OverrideOnDemand
 @OverridingMethodsMustInvokeSuper
protected BDMSLServiceSoap createWSPort()

Create the main WebService client for the specified endpoint address.

Returns:

The WebService port to be used. May not be null.

prepareChangeCertificate

public void prepareChangeCertificate(@Nonnull @Nonempty
                                     String sNewCertificatePublicKey,
                                     @Nullable
                                     LocalDate aMigrationDate)
                              throws BadRequestFault,
                                     InternalErrorFault,
                                     NotFoundFault,
                                     UnauthorizedFault

This operation allows a SMP to prepare a change of its certificate. It is typically called when an SMP has a certificate that is about to expire and already has the new one.
This operation MUST be called while the certificate that is already registered in the SML is still valid.

Parameters:

sNewCertificatePublicKey - The new public key contained in the certificate.

aMigrationDate - The migration date for the new certificate. Can't be in the past. If the migrationDate is not empty, then the new certificate MUST be valid at the date provided in the migrationDate element. i.e. The migrationDate must be within validFrom and validTo dates of the new certificate. If the migrationDate element is empty, then the "Valid From" date is extracted from the certificate and is used as the migrationDate. In this case, the "Not Before" date of the certificate must be in the future.

Throws:

com.sun.xml.ws.client.ClientTransportException - if the WS client invocation failed

BadRequestFault - In case of error

InternalErrorFault - In case of error

NotFoundFault - In case of error

UnauthorizedFault - In case of error

changeCertificate

public void changeCertificate(@Nonnull
                              String sSMPID,
                              @Nonnull @Nonempty
                              byte[] aNewCertificatePublicKey)
                       throws BadRequestFault,
                              InternalErrorFault,
                              UnauthorizedFault

Change a certificate

Parameters:

sSMPID - The SMP identifier

aNewCertificatePublicKey - The new public key contained in the certificate.

Throws:

com.sun.xml.ws.client.ClientTransportException - if the WS client invocation failed

BadRequestFault - In case of error

InternalErrorFault - In case of error

UnauthorizedFault - In case of error

createParticipantIdentifier

public void createParticipantIdentifier(@Nonnull @Nonempty
                                        String sSMPID,
                                        @Nonnull
                                        com.helger.peppolid.IParticipantIdentifier aParticipantID,
                                        @Nonnull @Nonempty
                                        String sServiceName)
                                 throws BadRequestFault,
                                        InternalErrorFault,
                                        NotFoundFault,
                                        UnauthorizedFault

Throws:

BadRequestFault

InternalErrorFault

NotFoundFault

UnauthorizedFault

listParticipants

@Nullable
public com.helger.commons.collection.impl.ICommonsList<ParticipantListItem> listParticipants()
                                                                                                 throws InternalErrorFault

Throws:

InternalErrorFault

isAlive

public boolean isAlive()

clearCache

public void clearCache()
                throws InternalErrorFault

Throws:

InternalErrorFault