org.mitre.taxii.messages.xml11

Class PollResponse

java.lang.Object

org.mitre.taxii.messages.xml11.MessageType

org.mitre.taxii.messages.xml11.ResponseMessageType

org.mitre.taxii.messages.xml11.PollResponse

All Implemented Interfaces:

org.jvnet.jaxb2_commons.lang.Equals, org.jvnet.jaxb2_commons.lang.HashCode

public class PollResponse
extends ResponseMessageType
implements org.jvnet.jaxb2_commons.lang.Equals, org.jvnet.jaxb2_commons.lang.HashCode

Type for the Poll Response Messages.

Java class for TAXIIPollResponseType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="TAXIIPollResponseType">
   <complexContent>
     <extension base="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}ResponseMessageType">
       <sequence>
         <element name="Subscription_ID" type="{http://www.w3.org/2001/XMLSchema}anyURI" minOccurs="0"/>
         <element name="Exclusive_Begin_Timestamp" type="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}TimestampLabelType" minOccurs="0"/>
         <element name="Inclusive_End_Timestamp" type="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}TimestampLabelType" minOccurs="0"/>
         <element name="Record_Count" type="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}RecordCountType" minOccurs="0"/>
         <element name="Message" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element ref="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}Content_Block" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.w3.org/2000/09/xmldsig#}Signature" minOccurs="0"/>
       </sequence>
       <attribute name="collection_name" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="more" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="result_id" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="result_part_number" type="{http://www.w3.org/2001/XMLSchema}positiveInteger" default="1" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	collectionName
protected java.util.List<ContentBlock>	contentBlocks
protected javax.xml.datatype.XMLGregorianCalendar	exclusiveBeginTimestamp
protected javax.xml.datatype.XMLGregorianCalendar	inclusiveEndTimestamp
protected java.lang.String	message
protected java.lang.Boolean	more
protected RecordCountType	recordCount
protected java.lang.String	resultId
protected java.math.BigInteger	resultPartNumber
protected Signature	signature
protected java.lang.String	subscriptionID

Fields inherited from class org.mitre.taxii.messages.xml11.ResponseMessageType

inResponseTo

Fields inherited from class org.mitre.taxii.messages.xml11.MessageType

extendedHeaders, messageId

Constructor Summary

Constructors

Constructor and Description
PollResponse() Default no-arg constructor
PollResponse(ExtendedHeadersType extendedHeaders, java.lang.String messageId, java.lang.String inResponseTo, java.lang.String subscriptionID, javax.xml.datatype.XMLGregorianCalendar exclusiveBeginTimestamp, javax.xml.datatype.XMLGregorianCalendar inclusiveEndTimestamp, RecordCountType recordCount, java.lang.String message, java.util.List<ContentBlock> contentBlocks, Signature signature, java.lang.String collectionName, java.lang.Boolean more, java.lang.String resultId, java.math.BigInteger resultPartNumber) Fully-initialising value constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object)
boolean	equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, java.lang.Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy strategy)
java.lang.String	getCollectionName() Gets the value of the collectionName property.
java.util.List<ContentBlock>	getContentBlocks() Returned content.Gets the value of the contentBlocks property.
javax.xml.datatype.XMLGregorianCalendar	getExclusiveBeginTimestamp() Gets the value of the exclusiveBeginTimestamp property.
javax.xml.datatype.XMLGregorianCalendar	getInclusiveEndTimestamp() Gets the value of the inclusiveEndTimestamp property.
java.lang.String	getMessage() Gets the value of the message property.
RecordCountType	getRecordCount() Gets the value of the recordCount property.
java.lang.String	getResultId() Gets the value of the resultId property.
java.math.BigInteger	getResultPartNumber() Gets the value of the resultPartNumber property.
Signature	getSignature() An XML Digital Signature scoped to this message.
java.lang.String	getSubscriptionID() Gets the value of the subscriptionID property.
int	hashCode()
int	hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy strategy)
boolean	isMore() Gets the value of the more property.
void	setCollectionName(java.lang.String value) Sets the value of the collectionName property.
void	setExclusiveBeginTimestamp(javax.xml.datatype.XMLGregorianCalendar value) Sets the value of the exclusiveBeginTimestamp property.
void	setInclusiveEndTimestamp(javax.xml.datatype.XMLGregorianCalendar value) Sets the value of the inclusiveEndTimestamp property.
void	setMessage(java.lang.String value) Sets the value of the message property.
void	setMore(java.lang.Boolean value) Sets the value of the more property.
void	setRecordCount(RecordCountType value) Sets the value of the recordCount property.
void	setResultId(java.lang.String value) Sets the value of the resultId property.
void	setResultPartNumber(java.math.BigInteger value) Sets the value of the resultPartNumber property.
void	setSignature(Signature value) Sets the value of the signature property.
void	setSubscriptionID(java.lang.String value) Sets the value of the subscriptionID property.
PollResponse	withCollectionName(java.lang.String value)
PollResponse	withContentBlocks(java.util.Collection<ContentBlock> values)
PollResponse	withContentBlocks(ContentBlock... values)
PollResponse	withExclusiveBeginTimestamp(javax.xml.datatype.XMLGregorianCalendar value)
PollResponse	withExtendedHeaders(ExtendedHeadersType value)
PollResponse	withInclusiveEndTimestamp(javax.xml.datatype.XMLGregorianCalendar value)
PollResponse	withInResponseTo(java.lang.String value)
PollResponse	withMessage(java.lang.String value)
PollResponse	withMessageId(java.lang.String value)
PollResponse	withMore(java.lang.Boolean value)
PollResponse	withRecordCount(RecordCountType value)
PollResponse	withResultId(java.lang.String value)
PollResponse	withResultPartNumber(java.math.BigInteger value)
PollResponse	withSignature(Signature value)
PollResponse	withSubscriptionID(java.lang.String value)

Methods inherited from class org.mitre.taxii.messages.xml11.ResponseMessageType

getInResponseTo, setInResponseTo

Methods inherited from class org.mitre.taxii.messages.xml11.MessageType

getExtendedHeaders, getMessageId, setExtendedHeaders, setMessageId

Methods inherited from class java.lang.Object

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

Field Detail

subscriptionID

protected java.lang.String subscriptionID

exclusiveBeginTimestamp

protected javax.xml.datatype.XMLGregorianCalendar exclusiveBeginTimestamp

inclusiveEndTimestamp

protected javax.xml.datatype.XMLGregorianCalendar inclusiveEndTimestamp

recordCount

protected RecordCountType recordCount

message

protected java.lang.String message

contentBlocks

protected java.util.List<ContentBlock> contentBlocks

signature

protected Signature signature

collectionName

protected java.lang.String collectionName

more

protected java.lang.Boolean more

resultId

protected java.lang.String resultId

resultPartNumber

protected java.math.BigInteger resultPartNumber

Constructor Detail

PollResponse

public PollResponse()

Default no-arg constructor

PollResponse

public PollResponse(ExtendedHeadersType extendedHeaders,
            java.lang.String messageId,
            java.lang.String inResponseTo,
            java.lang.String subscriptionID,
            javax.xml.datatype.XMLGregorianCalendar exclusiveBeginTimestamp,
            javax.xml.datatype.XMLGregorianCalendar inclusiveEndTimestamp,
            RecordCountType recordCount,
            java.lang.String message,
            java.util.List<ContentBlock> contentBlocks,
            Signature signature,
            java.lang.String collectionName,
            java.lang.Boolean more,
            java.lang.String resultId,
            java.math.BigInteger resultPartNumber)

Fully-initialising value constructor

Method Detail

getSubscriptionID

public java.lang.String getSubscriptionID()

Gets the value of the subscriptionID property.

Returns:

possible object is String

setSubscriptionID

public void setSubscriptionID(java.lang.String value)

Sets the value of the subscriptionID property.

Parameters:

value - allowed object is String

getExclusiveBeginTimestamp

public javax.xml.datatype.XMLGregorianCalendar getExclusiveBeginTimestamp()

Gets the value of the exclusiveBeginTimestamp property.

Returns:

possible object is XMLGregorianCalendar

setExclusiveBeginTimestamp

public void setExclusiveBeginTimestamp(javax.xml.datatype.XMLGregorianCalendar value)

Sets the value of the exclusiveBeginTimestamp property.

Parameters:

value - allowed object is XMLGregorianCalendar

getInclusiveEndTimestamp

public javax.xml.datatype.XMLGregorianCalendar getInclusiveEndTimestamp()

Gets the value of the inclusiveEndTimestamp property.

Returns:

possible object is XMLGregorianCalendar

setInclusiveEndTimestamp

public void setInclusiveEndTimestamp(javax.xml.datatype.XMLGregorianCalendar value)

Sets the value of the inclusiveEndTimestamp property.

Parameters:

value - allowed object is XMLGregorianCalendar

getRecordCount

public RecordCountType getRecordCount()

Gets the value of the recordCount property.

Returns:

possible object is RecordCountType

setRecordCount

public void setRecordCount(RecordCountType value)

Sets the value of the recordCount property.

Parameters:

value - allowed object is RecordCountType

getMessage

public java.lang.String getMessage()

Gets the value of the message property.

Returns:

possible object is String

setMessage

public void setMessage(java.lang.String value)

Sets the value of the message property.

Parameters:

value - allowed object is String

getContentBlocks

public java.util.List<ContentBlock> getContentBlocks()

Returned content.Gets the value of the contentBlocks property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the contentBlocks property.

For example, to add a new item, do as follows:

    getContentBlocks().add(newItem);
 

Objects of the following type(s) are allowed in the list ContentBlock

getSignature

public Signature getSignature()

An XML Digital Signature scoped to this message.

Returns:

possible object is Signature

setSignature

public void setSignature(Signature value)

Sets the value of the signature property.

Parameters:

value - allowed object is Signature

getCollectionName

public java.lang.String getCollectionName()

Gets the value of the collectionName property.

Returns:

possible object is String

setCollectionName

public void setCollectionName(java.lang.String value)

Sets the value of the collectionName property.

Parameters:

value - allowed object is String

isMore

public boolean isMore()

Gets the value of the more property.

Returns:

possible object is Boolean

setMore

public void setMore(java.lang.Boolean value)

Sets the value of the more property.

Parameters:

value - allowed object is Boolean

getResultId

public java.lang.String getResultId()

Gets the value of the resultId property.

Returns:

possible object is String

setResultId

public void setResultId(java.lang.String value)

Sets the value of the resultId property.

Parameters:

value - allowed object is String

getResultPartNumber

public java.math.BigInteger getResultPartNumber()

Gets the value of the resultPartNumber property.

Returns:

possible object is BigInteger

setResultPartNumber

public void setResultPartNumber(java.math.BigInteger value)

Sets the value of the resultPartNumber property.

Parameters:

value - allowed object is BigInteger

equals

public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
             org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
             java.lang.Object object,
             org.jvnet.jaxb2_commons.lang.EqualsStrategy strategy)

Specified by:

equals in interface org.jvnet.jaxb2_commons.lang.Equals

Overrides:

equals in class ResponseMessageType

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class ResponseMessageType

hashCode

public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
           org.jvnet.jaxb2_commons.lang.HashCodeStrategy strategy)

Specified by:

hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode

Overrides:

hashCode in class ResponseMessageType

hashCode

public int hashCode()

Overrides:

hashCode in class ResponseMessageType

withSubscriptionID

public PollResponse withSubscriptionID(java.lang.String value)

withExclusiveBeginTimestamp

public PollResponse withExclusiveBeginTimestamp(javax.xml.datatype.XMLGregorianCalendar value)

withInclusiveEndTimestamp

public PollResponse withInclusiveEndTimestamp(javax.xml.datatype.XMLGregorianCalendar value)

withRecordCount

public PollResponse withRecordCount(RecordCountType value)

withMessage

public PollResponse withMessage(java.lang.String value)

withContentBlocks

public PollResponse withContentBlocks(ContentBlock... values)

withContentBlocks

public PollResponse withContentBlocks(java.util.Collection<ContentBlock> values)

withSignature

public PollResponse withSignature(Signature value)

withCollectionName

public PollResponse withCollectionName(java.lang.String value)

withMore

public PollResponse withMore(java.lang.Boolean value)

withResultId

public PollResponse withResultId(java.lang.String value)

withResultPartNumber

public PollResponse withResultPartNumber(java.math.BigInteger value)

withInResponseTo

public PollResponse withInResponseTo(java.lang.String value)

Overrides:

withInResponseTo in class ResponseMessageType

withExtendedHeaders

public PollResponse withExtendedHeaders(ExtendedHeadersType value)

Overrides:

withExtendedHeaders in class ResponseMessageType

withMessageId

public PollResponse withMessageId(java.lang.String value)

Overrides:

withMessageId in class ResponseMessageType