gov.nist.toolkit.toolkitServicesCommon

Interface RawSendRequest

All Superinterfaces:

SimId

public interface RawSendRequest
extends SimId

Send Request. Raw means that the user provides the SOAP Header, SOAP Body and document map to send. No updates are done the the metadata. It is sent as provided.

Method Summary

Modifier and Type	Method and Description
void	addDocument(java.lang.String id, DocumentResource doc) Add a Document to the send request.
void	addExtraHeader(java.lang.String extraHeader) An extra header is a well formed XML element that will be added to the SOAPHeader of the sent message.
java.util.Map<java.lang.String,DocumentResource>	getDocuments() Get map of id to Document.
java.util.Collection<java.lang.String>	getExtraHeaders()
java.lang.String	getMetadata()
java.lang.String	getTransactionName()
boolean	isTls()
void	setMetadata(java.lang.String metadata) Metadata as a String.
void	setTls(boolean tls) Send over TLS?
void	setTransactionName(java.lang.String transactionName) Id of the transaction to send.

Methods inherited from interface gov.nist.toolkit.toolkitServicesCommon.SimId

getActorType, getEnvironmentName, getFullId, getId, getUser, isFhir

Method Detail

addDocument

void addDocument(java.lang.String id,
                 DocumentResource doc)

Add a Document to the send request. The id must match the id attribute on an ExtrinsicObject in the metadata.

Parameters:

id -

doc -

getTransactionName

java.lang.String getTransactionName()

setTransactionName

void setTransactionName(java.lang.String transactionName)

Id of the transaction to send.

Parameters:

transactionName - transaction id

isTls

boolean isTls()

setTls

void setTls(boolean tls)

Send over TLS?

Parameters:

tls - -

getMetadata

java.lang.String getMetadata()

setMetadata

void setMetadata(java.lang.String metadata)

Metadata as a String. It must be well formed XML (pass an XML parse). This will be the XML child element of the SOAPBody element. For a Provide and Register transaction the top element will be the ProvideAndRegisterDocumentSetRequest element.

Parameters:

metadata - XML

getExtraHeaders

java.util.Collection<java.lang.String> getExtraHeaders()

addExtraHeader

void addExtraHeader(java.lang.String extraHeader)

An extra header is a well formed XML element that will be added to the SOAPHeader of the sent message.

Parameters:

extraHeader - well formed XML

getDocuments

java.util.Map<java.lang.String,DocumentResource> getDocuments()

Get map of id to Document. The id is the is attribute value in a Document Sharing ExtrinsicObject.

Returns:

the map.