Package de.aeb.xnsg.foundation.bf

Class AbstractRequestDTO

java.lang.Object

de.aeb.xnsg.foundation.bf.AbstractRequestDTO

Direct Known Subclasses:

AcknowledgeEventsRequestDTO, AcknowledgePublishedDataFeedPartsRequestDTO, AcknowledgePublishedDataTransferPackagesRequestDTO, CreateClientFromTemplateRequestDTO, ExternalTMIdentificationRequestDTO, GetClientFeaturesRequestDTO, GetCreateClientFromTemplateStatusRequestDTO, GetDataFeedPartContentRequestDTO, GetPartnerSystemSubscriptionsRequestDTO, GetPublishedDataFeedPartsRequestDTO, GetPublishedDataTransferPackageRequestDTO, GetRolesRequestDTO, SetClientFeaturesRequestDTO, SetSyncEventRequestDTO, SubscribePartnerSystemRequestDTO, SyncEventsRequestDTO, UnsubscribePartnerSystemRequestDTO

public class AbstractRequestDTO
extends Object

Abstract DTO superclass with typical request data.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientIdentCode	Client identification code.
String	clientSystemId	Id of the sending client system.
String[]	resultLanguageIsoCodes	2-letter ISO codes of the languages in which texts will be returned.
String	userName	User who initiated the request from the client system.

Constructor Summary

Constructors

Constructor	Description
AbstractRequestDTO()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

clientSystemId

public String clientSystemId

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

clientIdentCode

public String clientIdentCode

Client identification code.

Maximum length: 10

userName

public String userName

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic "I_EVERYONE" role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

resultLanguageIsoCodes

public String[] resultLanguageIsoCodes

2-letter ISO codes of the languages in which texts will be returned.

English ("en") and German ("de") are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

Constructor Details

AbstractRequestDTO

public AbstractRequestDTO()