public class ManageParticipantIdentifierServiceCaller
extends com.helger.wsclient.WSClientConfig
| Constructor and Description |
|---|
ManageParticipantIdentifierServiceCaller(com.helger.peppol.sml.ISMLInfo aSMLInfo)
Constructs a service caller for the manage business identifier interface.
|
ManageParticipantIdentifierServiceCaller(URL aEndpointAddress)
Constructs a service caller for the manage business identifier interface.
|
| Modifier and Type | Method and Description |
|---|---|
void |
create(ServiceMetadataPublisherServiceForParticipantType aSMPParticpantService)
Creates a new business identifier for the SMP given by the publisher id in
ServiceMetadataPublisherServiceForParticipantType.
|
void |
create(String sSMPID,
com.helger.peppolid.IParticipantIdentifier aIdentifier)
Creates a new participant identifier for the SMP given by the ID.
|
void |
createList(Iterable<? extends com.helger.peppolid.IParticipantIdentifier> aParticipantIdentifiers,
String sSMPID)
Creates a list of participant identifiers.
|
static String |
createRandomMigrationKey() |
protected ManageBusinessIdentifierServiceSoap |
createWSPort()
Create the main WebService client for the specified endpoint address.
|
void |
delete(ServiceMetadataPublisherServiceForParticipantType aSMPParticpantService)
Deletes a given participant identifier given by the
ServiceMetadataPublisherServiceForBusinessType parameter.
|
void |
delete(String sSMPID,
com.helger.peppolid.IParticipantIdentifier aIdentifier)
Deletes a given participant identifier.
|
void |
deleteList(Iterable<? extends com.helger.peppolid.ParticipantIdentifierType> aParticipantIdentifiers)
Deletes a list of participant identifiers
|
static String |
getSuitableMigrationKey(String sBaseKey)
Ensure that the migration key used has at last 24 characters.
|
ParticipantIdentifierPageType |
list(PageRequestType aPageRequest)
Lists the participant identifiers registered for the SMP associated with
the publisher id.
|
ParticipantIdentifierPageType |
list(String sPageId,
String sSMPID)
Lists the participant identifiers registered for the SMP associated with
the publisher id.
|
void |
migrate(com.helger.peppolid.IParticipantIdentifier aIdentifier,
String sMigrationKey,
String sSMPID)
Migrates a given participant identifier to an SMP given by the publisher
id.
|
String |
prepareToMigrate(com.helger.peppolid.IParticipantIdentifier aIdentifier,
String sSMPID)
Prepares a migrate of the given participant identifier.
|
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, setWorkAroundMASM0003public ManageParticipantIdentifierServiceCaller(@Nonnull com.helger.peppol.sml.ISMLInfo aSMLInfo)
aSMLInfo - The SML info object. May not be null.public ManageParticipantIdentifierServiceCaller(@Nonnull URL aEndpointAddress)
aEndpointAddress - The URL of the manage participant identifier interface. May not be
null.@Nonnull @OverrideOnDemand @OverridingMethodsMustInvokeSuper protected ManageBusinessIdentifierServiceSoap createWSPort()
null.public void create(@Nonnull @Nonempty String sSMPID, @Nonnull com.helger.peppolid.IParticipantIdentifier aIdentifier) throws BadRequestFault, InternalErrorFault, UnauthorizedFault, NotFoundFault
sSMPID - Identifies the SMP to create the identifier for. Example:
test-smp-0000000001aIdentifier - The identifier to be created. May not be null.BadRequestFault - Is thrown if the request sent to the service was not well-formed.InternalErrorFault - Is thrown if an internal error happened on the service.UnauthorizedFault - Is thrown if the user was not authorized.NotFoundFault - Is thrown if the service meta data publisher was not found.public void create(@Nonnull ServiceMetadataPublisherServiceForParticipantType aSMPParticpantService) throws BadRequestFault, InternalErrorFault, UnauthorizedFault, NotFoundFault
aSMPParticpantService - Specifies the identifier to create. May not be null.BadRequestFault - Is thrown if the request sent to the service was not well-formed.InternalErrorFault - Is thrown if an internal error happened on the service.UnauthorizedFault - Is thrown if the user was not authorized.NotFoundFault - Is thrown if the service meta data publisher was not found.public void createList(@Nonnull @Nonempty Iterable<? extends com.helger.peppolid.IParticipantIdentifier> aParticipantIdentifiers, @Nonnull @Nonempty String sSMPID) throws BadRequestFault, InternalErrorFault, NotFoundFault, UnauthorizedFault
aParticipantIdentifiers - The collection of identifiers to create. May neither be
null nor empty nor may it contain null
values.sSMPID - The id of the service meta data. May neither be null
nor empty.BadRequestFault - Is thrown if the request sent to the service was not well-formed.InternalErrorFault - Is thrown if an internal error happened on the service.NotFoundFault - If the SMP does not existUnauthorizedFault - Is thrown if the user was not authorized.public void delete(@Nonnull @Nonempty String sSMPID, @Nonnull com.helger.peppolid.IParticipantIdentifier aIdentifier) throws BadRequestFault, InternalErrorFault, NotFoundFault, UnauthorizedFault
sSMPID - The id of the service meta data. May neither be null
nor empty.aIdentifier - The business identifier to delete. May not be null.BadRequestFault - Is thrown if the request sent to the service was not well-formed.InternalErrorFault - Is thrown if an internal error happened on the service.NotFoundFault - Is thrown if the business identifier could not be found and
therefore deleted.UnauthorizedFault - Is thrown if the user was not authorized.public void delete(@Nonnull ServiceMetadataPublisherServiceForParticipantType aSMPParticpantService) throws BadRequestFault, InternalErrorFault, NotFoundFault, UnauthorizedFault
aSMPParticpantService - The participant identifier to delete. May be null.BadRequestFault - Is thrown if the request sent to the service was not well-formed.InternalErrorFault - Is thrown if an internal error happened on the service.NotFoundFault - Is thrown if the business identifier could not be found and
therefore deleted.UnauthorizedFault - Is thrown if the user was not authorized.public void deleteList(@Nonnull @Nonempty Iterable<? extends com.helger.peppolid.ParticipantIdentifierType> aParticipantIdentifiers) throws BadRequestFault, InternalErrorFault, NotFoundFault, UnauthorizedFault
aParticipantIdentifiers - The list of participant identifiers. May neither be
null nor empty nor may it contain null
values.BadRequestFault - Is thrown if the request sent to the service was not well-formed.InternalErrorFault - Is thrown if an internal error happened on the service.NotFoundFault - Is thrown if a business identifier could not be found and therefore
deleted.UnauthorizedFault - Is thrown if the user was not authorized.public ParticipantIdentifierPageType list(@Nonnull String sPageId, @Nonnull @Nonempty String sSMPID) throws BadRequestFault, InternalErrorFault, NotFoundFault, UnauthorizedFault
sPageId - The id of the next page. May not be null but maybe
empty if it is the first page.sSMPID - The publisher id corresponding to the SMP. May neither be
null nor empty.BadRequestFault - Is thrown if the request sent to the service was not well-formed.InternalErrorFault - Is thrown if an internal error happened on the service.NotFoundFault - Is thrown if certificateUid was not found.UnauthorizedFault - Is thrown if the user was not authorized.public ParticipantIdentifierPageType list(@Nonnull PageRequestType aPageRequest) throws BadRequestFault, InternalErrorFault, NotFoundFault, UnauthorizedFault
aPageRequest - The page requestBadRequestFault - Is thrown if the request sent to the service was not well-formed.InternalErrorFault - Is thrown if an internal error happened on the service.NotFoundFault - Is thrown if certificateUid was not found.UnauthorizedFault - Is thrown if the user was not authorized.@Nonnull @Nonempty public static final String getSuitableMigrationKey(@Nonnull @Nonempty String sBaseKey)
sBaseKey - The base migration key. May not be null. E.g.
UUID.toString()CSMLDefault.MAX_MIGRATION_CODE_LENGTH@Nonnull @Nonempty public static final String createRandomMigrationKey()
@Nonnull public String prepareToMigrate(@Nonnull com.helger.peppolid.IParticipantIdentifier aIdentifier, @Nonnull @Nonempty String sSMPID) throws BadRequestFault, InternalErrorFault, NotFoundFault, UnauthorizedFault
aIdentifier - The participant identifier.sSMPID - SMP IDBadRequestFault - Is thrown if the request sent to the service was not well-formed.InternalErrorFault - Is thrown if an internal error happened on the service.NotFoundFault - If the business identifier was not found.UnauthorizedFault - Is thrown if the user was not authorized.public void migrate(@Nonnull com.helger.peppolid.IParticipantIdentifier aIdentifier, @Nonnull @Nonempty String sMigrationKey, @Nonnull @Nonempty String sSMPID) throws BadRequestFault, InternalErrorFault, NotFoundFault, UnauthorizedFault
aIdentifier - The participant identifier to migrate. May not be null.sMigrationKey - The migration key received by the previous owner. May not be
null. Must have at last 24 characters.sSMPID - The publisher id corresponding to the new owner SMP. May neither be
null nor empty.BadRequestFault - Is thrown if the request sent to the service was not well-formed.InternalErrorFault - Is thrown if an internal error happened on the service.NotFoundFault - If the business identifier was not found.UnauthorizedFault - Is thrown if the user was not authorized.Copyright © 2015–2019 Philip Helger. All rights reserved.