Package be.vlaanderen.vip.magda.client

Class MagdaRequest

java.lang.Object

be.vlaanderen.vip.magda.client.MagdaRequest

Direct Known Subclasses:

CompanyMagdaRequest, PersonMagdaRequest, SubjectMagdaRequest

public abstract class MagdaRequest
extends Object

The common part of a request to a MAGDA service. Has subclasses for specific service/versions.

Contains:

• correlationId: unique correlation ID of the request
• requestId: unique ID of the request
• registration: registration code that can be resolved by a MagdaHoedanigService to obtain registration info (defaults to code "default" if not specified); a MagdaRegistrationInfo object can be directly given too.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	MagdaRequest.Builder<SELF extends MagdaRequest.Builder<SELF>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_REGISTRATION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MagdaRequest(@NotNull Registration registration)

Method Summary

Modifier and Type	Method	Description
protected abstract void	fillIn(MagdaDocument request, UUID requestId, MagdaRegistrationInfo magdaRegistrationInfo, Instant instant)
protected void	fillInCommonFields(MagdaDocument request, UUID requestId, MagdaRegistrationInfo magdaRegistrationInfo, Instant instant)
abstract SubjectIdentificationNumber	getSubject()
abstract MagdaServiceIdentification	magdaServiceIdentification()
MagdaDocument	toMagdaDocument(UUID requestId, MagdaRegistrationInfo magdaRegistrationInfo)
MagdaDocument	toMagdaDocument(UUID requestId, MagdaRegistrationInfo magdaRegistrationInfo, Instant instant)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_REGISTRATION

public static final String DEFAULT_REGISTRATION

See Also:

• Constant Field Values

Constructor Details

MagdaRequest

protected MagdaRequest(@NotNull
 @NotNull Registration registration)

Method Details

magdaServiceIdentification

public abstract MagdaServiceIdentification magdaServiceIdentification()

getSubject

public abstract SubjectIdentificationNumber getSubject()

toMagdaDocument

public MagdaDocument toMagdaDocument(UUID requestId,
 MagdaRegistrationInfo magdaRegistrationInfo,
 Instant instant)

toMagdaDocument

public MagdaDocument toMagdaDocument(UUID requestId,
 MagdaRegistrationInfo magdaRegistrationInfo)

fillInCommonFields

protected void fillInCommonFields(MagdaDocument request,
 UUID requestId,
 MagdaRegistrationInfo magdaRegistrationInfo,
 Instant instant)

fillIn

protected abstract void fillIn(MagdaDocument request,
 UUID requestId,
 MagdaRegistrationInfo magdaRegistrationInfo,
 Instant instant)