org.mitre.taxii.messages.xml11

Class StatusMessageHelper

java.lang.Object

org.mitre.taxii.messages.xml11.StatusMessageHelper

public final class StatusMessageHelper
extends java.lang.Object

Utility methods for Status Messages.

Constructor Summary

Constructors

Constructor and Description
StatusMessageHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static StatusMessage	addDetail(StatusMessage sm, java.net.URI name, java.lang.Object... content) Add a single detail to a Status Message.
static StatusMessage	addDetails(StatusMessage sm, java.util.Map<java.net.URI,java.lang.Object> detailsMap) Add a set of "Detail" elements to a Status Message.
static StatusMessage	createInvalidResponsePart(int maxPartNumber) Utility method to create an "Invalid Response Part" Status Message.
static StatusMessage	createPending(int estimatedWait, java.net.URI resultId, boolean willPush) Utility method to create a "Pending" Status Message.
static StatusDetailDetailType	createStatusDetailDetail(java.net.URI name, java.lang.Object value) Utility method to create a status detail with the given name and value.
static java.util.List<?>	findStatusDetailContentByName(StatusMessage msg, java.lang.String name) Returns the contents of the named status detail record.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusMessageHelper

public StatusMessageHelper()

Method Detail

findStatusDetailContentByName

public static java.util.List<?> findStatusDetailContentByName(StatusMessage msg,
                                              java.lang.String name)

Returns the contents of the named status detail record.

Returns:

the contents of the named status detail record, or null if no such status detail record exists.

createInvalidResponsePart

public static StatusMessage createInvalidResponsePart(int maxPartNumber)

Utility method to create an "Invalid Response Part" Status Message.

Parameters:

maxPartNumber -

Returns:

Status Message pre-populated for "Invalid Response Part".

createPending

public static StatusMessage createPending(int estimatedWait,
                          java.net.URI resultId,
                          boolean willPush)

Utility method to create a "Pending" Status Message.

Parameters:

estimatedWait -

resultId -

willPush -

Returns:

pre-populated "Pending" Status Message.

createStatusDetailDetail

public static StatusDetailDetailType createStatusDetailDetail(java.net.URI name,
                                              java.lang.Object value)

Utility method to create a status detail with the given name and value.

Parameters:

name -

value -

Returns:

status detail with a given name and value.

addDetails

public static StatusMessage addDetails(StatusMessage sm,
                       java.util.Map<java.net.URI,java.lang.Object> detailsMap)

Add a set of "Detail" elements to a Status Message.

Parameters:

sm - - The Status Message to be modified

detailsMap - - The set of details to add.

Returns:

Status Message with added details.

addDetail

public static StatusMessage addDetail(StatusMessage sm,
                      java.net.URI name,
                      java.lang.Object... content)

Add a single detail to a Status Message. The content is a variable length list of arguments. A set of detail elements with the same name will be created if multiple values are given. NOTE: Each item in the content argument will be toString()ed when added to the detail element.

Parameters:

sm -

name -

content - - list of values. These will be toString()ed.

Returns:

Status Message with detail(s) added.