org.mitre.taxii.messages.xml11

Class PollRequest

java.lang.Object

org.mitre.taxii.messages.xml11.MessageType

org.mitre.taxii.messages.xml11.RequestMessageType

org.mitre.taxii.messages.xml11.PollRequest

All Implemented Interfaces:

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

public class PollRequest
extends RequestMessageType
implements org.jvnet.jaxb2_commons.lang.Equals, org.jvnet.jaxb2_commons.lang.HashCode

A request to Poll a data collection.

Java class for TAXIIPollRequestType complex type.

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

 <complexType name="TAXIIPollRequestType">
   <complexContent>
     <extension base="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}RequestMessageType">
       <sequence>
         <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"/>
         <choice>
           <element name="Subscription_ID" type="{http://www.w3.org/2001/XMLSchema}anyURI"/>
           <element name="Poll_Parameters" type="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}PollParametersType"/>
         </choice>
         <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" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	collectionName
protected javax.xml.datatype.XMLGregorianCalendar	exclusiveBeginTimestamp
protected javax.xml.datatype.XMLGregorianCalendar	inclusiveEndTimestamp
protected PollParametersType	pollParameters
protected Signature	signature
protected java.lang.String	subscriptionID

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

extendedHeaders, messageId

Constructor Summary

Constructors

Constructor and Description
PollRequest() Default no-arg constructor
PollRequest(ExtendedHeadersType extendedHeaders, java.lang.String messageId, javax.xml.datatype.XMLGregorianCalendar exclusiveBeginTimestamp, javax.xml.datatype.XMLGregorianCalendar inclusiveEndTimestamp, PollParametersType pollParameters, java.lang.String subscriptionID, Signature signature, java.lang.String collectionName) 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.
javax.xml.datatype.XMLGregorianCalendar	getExclusiveBeginTimestamp() Gets the value of the exclusiveBeginTimestamp property.
javax.xml.datatype.XMLGregorianCalendar	getInclusiveEndTimestamp() Gets the value of the inclusiveEndTimestamp property.
PollParametersType	getPollParameters() Gets the value of the pollParameters 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)
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	setPollParameters(PollParametersType value) Sets the value of the pollParameters 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.
PollRequest	withCollectionName(java.lang.String value)
PollRequest	withExclusiveBeginTimestamp(javax.xml.datatype.XMLGregorianCalendar value)
PollRequest	withExtendedHeaders(ExtendedHeadersType value)
PollRequest	withInclusiveEndTimestamp(javax.xml.datatype.XMLGregorianCalendar value)
PollRequest	withMessageId(java.lang.String value)
PollRequest	withPollParameters(PollParametersType value)
PollRequest	withSignature(Signature value)
PollRequest	withSubscriptionID(java.lang.String value)

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

exclusiveBeginTimestamp

protected javax.xml.datatype.XMLGregorianCalendar exclusiveBeginTimestamp

inclusiveEndTimestamp

protected javax.xml.datatype.XMLGregorianCalendar inclusiveEndTimestamp

pollParameters

protected PollParametersType pollParameters

subscriptionID

protected java.lang.String subscriptionID

signature

protected Signature signature

collectionName

protected java.lang.String collectionName

Constructor Detail

PollRequest

public PollRequest()

Default no-arg constructor

PollRequest

public PollRequest(ExtendedHeadersType extendedHeaders,
           java.lang.String messageId,
           javax.xml.datatype.XMLGregorianCalendar exclusiveBeginTimestamp,
           javax.xml.datatype.XMLGregorianCalendar inclusiveEndTimestamp,
           PollParametersType pollParameters,
           java.lang.String subscriptionID,
           Signature signature,
           java.lang.String collectionName)

Fully-initialising value constructor

Method Detail

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

getPollParameters

public PollParametersType getPollParameters()

Gets the value of the pollParameters property.

Returns:

possible object is PollParametersType

setPollParameters

public void setPollParameters(PollParametersType value)

Sets the value of the pollParameters property.

Parameters:

value - allowed object is PollParametersType

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

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

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 RequestMessageType

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class RequestMessageType

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 RequestMessageType

hashCode

public int hashCode()

Overrides:

hashCode in class RequestMessageType

withExclusiveBeginTimestamp

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

withInclusiveEndTimestamp

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

withPollParameters

public PollRequest withPollParameters(PollParametersType value)

withSubscriptionID

public PollRequest withSubscriptionID(java.lang.String value)

withSignature

public PollRequest withSignature(Signature value)

withCollectionName

public PollRequest withCollectionName(java.lang.String value)

withExtendedHeaders

public PollRequest withExtendedHeaders(ExtendedHeadersType value)

Overrides:

withExtendedHeaders in class RequestMessageType

withMessageId

public PollRequest withMessageId(java.lang.String value)

Overrides:

withMessageId in class RequestMessageType