com.helger.peppol.smlclient

Class ManageServiceMetadataServiceCaller

java.lang.Object

com.helger.wsclient.WSClientConfig

com.helger.peppol.smlclient.ManageServiceMetadataServiceCaller

public class ManageServiceMetadataServiceCaller
extends com.helger.wsclient.WSClientConfig

This class is used for calling the service meta data interface of the SML. It is used for connecting SMPs to the SML.

Author:

Ravnholt, PEPPOL.AT, BRZ, 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
ManageServiceMetadataServiceCaller(com.helger.peppol.sml.ISMLInfo aSMLInfo) Creates a service caller for the service metadata interface
ManageServiceMetadataServiceCaller(URL aEndpointAddress) Creates a service caller for the service meta data interface

Method Summary

Modifier and Type	Method and Description
void	create(ServiceMetadataPublisherServiceType aServiceMetadata) Creates the service metadata for the specified user.
void	create(String sSMPID, String sSMPAddressPhysical, String sSMPAddressLogical) Creates the service metadata for the specified user.
protected ManageServiceMetadataServiceSoap	createWSPort() Create the main WebService client for the specified endpoint address.
void	delete(String sSMPID) Deletes the service metadata given by the publisher id.
ServiceMetadataPublisherServiceType	read(ServiceMetadataPublisherServiceType aSMPService) Returns information about the publisher given by the publisher id.
ServiceMetadataPublisherServiceType	read(String sSMPID) Returns information about the publisher given by the publisher id.
void	update(ServiceMetadataPublisherServiceType aServiceMetadata) Updates the specified service metadata.
void	update(String sSMPID, String sSMPAddressPhysical, String sSMPAddressLogical) Updates the specified service metadata given by the publisher id.
protected void	validateLogicalAddress(String sLogicalAddress) Custom validation method to provide additional logical address validation.
protected void	validatePhysicalAddress(String sPhysicalAddress) Custom validation method to provide additional physical address validation.

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

ManageServiceMetadataServiceCaller

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

Creates a service caller for the service metadata interface

Parameters:

aSMLInfo - The SML info object. May not be null.

ManageServiceMetadataServiceCaller

public ManageServiceMetadataServiceCaller(@Nonnull
                                          URL aEndpointAddress)

Creates a service caller for the service meta data interface

Parameters:

aEndpointAddress - The address of the SML management interface. May not be null.

Method Detail

createWSPort

@Nonnull
 @OverrideOnDemand
 @OverridingMethodsMustInvokeSuper
protected ManageServiceMetadataServiceSoap createWSPort()

Create the main WebService client for the specified endpoint address.

Returns:

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

validatePhysicalAddress

@OverrideOnDemand
protected void validatePhysicalAddress(@Nonnull @Nonempty
                                                          String sPhysicalAddress)

Custom validation method to provide additional physical address validation. Throw an IllegalArgumentException if validation fails.

Parameters:

sPhysicalAddress - The physical address to be validated. Neither null nor empty.

validateLogicalAddress

@OverrideOnDemand
protected void validateLogicalAddress(@Nonnull @Nonempty
                                                         String sLogicalAddress)

Custom validation method to provide additional logical address validation. Throw an IllegalArgumentException if validation fails.

Parameters:

sLogicalAddress - The logical address to be validated. Neither null nor empty.

create

public void create(@Nonnull @Nonempty
                   String sSMPID,
                   @Nonnull @Nonempty
                   String sSMPAddressPhysical,
                   @Nonnull @Nonempty
                   String sSMPAddressLogical)
            throws BadRequestFault,
                   InternalErrorFault,
                   UnauthorizedFault

Creates the service metadata for the specified user.

Parameters:

sSMPID - The certificate UID of the SMP. May neither be null nor empty.

sSMPAddressPhysical - The physical address of the SMP (Example: 198.0.0.1). May neither be null nor empty.

sSMPAddressLogical - The logical address of the SMP (Example: http://smp.example.org/). May neither be null nor empty.

Throws:

BadRequestFault - The request was not well formed.

InternalErrorFault - An internal error happened on the server.

UnauthorizedFault - The user name or password was not correct.

create

public void create(@Nonnull
                   ServiceMetadataPublisherServiceType aServiceMetadata)
            throws BadRequestFault,
                   InternalErrorFault,
                   UnauthorizedFault

Creates the service metadata for the specified user.

Parameters:

aServiceMetadata - The data about the SMP. May not be null.

Throws:

BadRequestFault - The request was not well formed.

InternalErrorFault - An internal error happened on the server.

UnauthorizedFault - The user name or password was not correct.

update

public void update(@Nonnull @Nonempty
                   String sSMPID,
                   @Nonnull @Nonempty
                   String sSMPAddressPhysical,
                   @Nonnull @Nonempty
                   String sSMPAddressLogical)
            throws InternalErrorFault,
                   NotFoundFault,
                   UnauthorizedFault,
                   BadRequestFault

Updates the specified service metadata given by the publisher id.

Parameters:

sSMPID - The publisher id. May neither be null nor empty.

sSMPAddressPhysical - The physical address of the SMP (Example: 198.0.0.1). May neither be null nor empty.

sSMPAddressLogical - The logical address of the SMP (Example: http://smp.example.org/). May neither be null nor empty.

Throws:

InternalErrorFault - An internal error happened on the server.

NotFoundFault - The service metadata with the given publisher id was not found.

UnauthorizedFault - The username or password was not correct.

BadRequestFault - The request was not well formed.

update

public void update(@Nonnull
                   ServiceMetadataPublisherServiceType aServiceMetadata)
            throws InternalErrorFault,
                   NotFoundFault,
                   UnauthorizedFault,
                   BadRequestFault

Updates the specified service metadata.

Parameters:

aServiceMetadata - The service metadata instance to update. May not be null.

Throws:

InternalErrorFault - An internal error happened on the server.

NotFoundFault - The service metadata with the given publisher id was not found.

UnauthorizedFault - The username or password was not correct.

BadRequestFault - The request was not well formed.

delete

public void delete(@Nonnull @Nonempty
                   String sSMPID)
            throws InternalErrorFault,
                   NotFoundFault,
                   UnauthorizedFault,
                   BadRequestFault

Deletes the service metadata given by the publisher id.

Parameters:

sSMPID - The publisher id of the service metadata to delete. May neither be null nor empty.

Throws:

InternalErrorFault - An internal error happened on the server.

NotFoundFault - The service metadata with the given publisher id was not found.

UnauthorizedFault - The username or password was not correct.

BadRequestFault - The request was not well formed.

read

@Nonnull
public ServiceMetadataPublisherServiceType read(@Nonnull @Nonempty
                                                          String sSMPID)
                                                   throws InternalErrorFault,
                                                          NotFoundFault,
                                                          UnauthorizedFault,
                                                          BadRequestFault

Returns information about the publisher given by the publisher id.

Parameters:

sSMPID - The publisher id of the service metadata to read.

Returns:

The service metadata given by the id.

Throws:

InternalErrorFault - An internal error happened on the server.

NotFoundFault - The service metadata with the given publisher id was not found.

UnauthorizedFault - The username or password was not correct.

BadRequestFault - The request was not well formed.

read

@Nonnull
public ServiceMetadataPublisherServiceType read(@Nonnull
                                                          ServiceMetadataPublisherServiceType aSMPService)
                                                   throws InternalErrorFault,
                                                          NotFoundFault,
                                                          UnauthorizedFault,
                                                          BadRequestFault

Returns information about the publisher given by the publisher id.

Parameters:

aSMPService - The publisher id is read from this service metadata object. May not be null.

Returns:

The service metadata given by the id.

Throws:

InternalErrorFault - An internal error happened on the server.

NotFoundFault - The service metadata with the given publisher id was not found.

UnauthorizedFault - The username or password was not correct.

BadRequestFault - The request was not well formed.