org.mitre.taxii.messages.xml11

Class SubscriptionManagementRequest

java.lang.Object

org.mitre.taxii.messages.xml11.MessageType

org.mitre.taxii.messages.xml11.RequestMessageType

org.mitre.taxii.messages.xml11.SubscriptionManagementRequest

All Implemented Interfaces:

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

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

Request management of a Data Collection subscription (including creation of a new subscription).

Java class for TAXIISubscriptionManagementRequestType complex type.

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

 <complexType name="TAXIISubscriptionManagementRequestType">
   <complexContent>
     <extension base="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}RequestMessageType">
       <sequence>
         <element name="Subscription_ID" type="{http://www.w3.org/2001/XMLSchema}anyURI" minOccurs="0"/>
         <element name="Subscription_Parameters" type="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}SubscriptionParametersType" minOccurs="0"/>
         <element name="Push_Parameters" type="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}PushParameterType" minOccurs="0"/>
         <element ref="{http://www.w3.org/2000/09/xmldsig#}Signature" minOccurs="0"/>
       </sequence>
       <attribute name="action" use="required" type="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}CollectionActionEnum" />
       <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 CollectionActionEnum	action
protected java.lang.String	collectionName
protected PushParameterType	pushParameters
protected Signature	signature
protected java.lang.String	subscriptionID
protected SubscriptionParametersType	subscriptionParameters

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

extendedHeaders, messageId

Constructor Summary

Constructors

Constructor and Description
SubscriptionManagementRequest() Default no-arg constructor
SubscriptionManagementRequest(ExtendedHeadersType extendedHeaders, java.lang.String messageId, java.lang.String subscriptionID, SubscriptionParametersType subscriptionParameters, PushParameterType pushParameters, Signature signature, CollectionActionEnum action, 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)
CollectionActionEnum	getAction() Gets the value of the action property.
java.lang.String	getCollectionName() Gets the value of the collectionName property.
PushParameterType	getPushParameters() Gets the value of the pushParameters property.
Signature	getSignature() An XML Digital Signature scoped to this message.
java.lang.String	getSubscriptionID() Gets the value of the subscriptionID property.
SubscriptionParametersType	getSubscriptionParameters() Gets the value of the subscriptionParameters property.
int	hashCode()
int	hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy strategy)
void	setAction(CollectionActionEnum value) Sets the value of the action property.
void	setCollectionName(java.lang.String value) Sets the value of the collectionName property.
void	setPushParameters(PushParameterType value) Sets the value of the pushParameters 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.
void	setSubscriptionParameters(SubscriptionParametersType value) Sets the value of the subscriptionParameters property.
SubscriptionManagementRequest	withAction(CollectionActionEnum value)
SubscriptionManagementRequest	withCollectionName(java.lang.String value)
SubscriptionManagementRequest	withExtendedHeaders(ExtendedHeadersType value)
SubscriptionManagementRequest	withMessageId(java.lang.String value)
SubscriptionManagementRequest	withPushParameters(PushParameterType value)
SubscriptionManagementRequest	withSignature(Signature value)
SubscriptionManagementRequest	withSubscriptionID(java.lang.String value)
SubscriptionManagementRequest	withSubscriptionParameters(SubscriptionParametersType 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

subscriptionID

protected java.lang.String subscriptionID

subscriptionParameters

protected SubscriptionParametersType subscriptionParameters

pushParameters

protected PushParameterType pushParameters

signature

protected Signature signature

action

protected CollectionActionEnum action

collectionName

protected java.lang.String collectionName

Constructor Detail

SubscriptionManagementRequest

public SubscriptionManagementRequest()

Default no-arg constructor

SubscriptionManagementRequest

public SubscriptionManagementRequest(ExtendedHeadersType extendedHeaders,
                             java.lang.String messageId,
                             java.lang.String subscriptionID,
                             SubscriptionParametersType subscriptionParameters,
                             PushParameterType pushParameters,
                             Signature signature,
                             CollectionActionEnum action,
                             java.lang.String collectionName)

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

getSubscriptionParameters

public SubscriptionParametersType getSubscriptionParameters()

Gets the value of the subscriptionParameters property.

Returns:

possible object is SubscriptionParametersType

setSubscriptionParameters

public void setSubscriptionParameters(SubscriptionParametersType value)

Sets the value of the subscriptionParameters property.

Parameters:

value - allowed object is SubscriptionParametersType

getPushParameters

public PushParameterType getPushParameters()

Gets the value of the pushParameters property.

Returns:

possible object is PushParameterType

setPushParameters

public void setPushParameters(PushParameterType value)

Sets the value of the pushParameters property.

Parameters:

value - allowed object is PushParameterType

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

getAction

public CollectionActionEnum getAction()

Gets the value of the action property.

Returns:

possible object is CollectionActionEnum

setAction

public void setAction(CollectionActionEnum value)

Sets the value of the action property.

Parameters:

value - allowed object is CollectionActionEnum

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

withSubscriptionID

public SubscriptionManagementRequest withSubscriptionID(java.lang.String value)

withSubscriptionParameters

public SubscriptionManagementRequest withSubscriptionParameters(SubscriptionParametersType value)

withPushParameters

public SubscriptionManagementRequest withPushParameters(PushParameterType value)

withSignature

public SubscriptionManagementRequest withSignature(Signature value)

withAction

public SubscriptionManagementRequest withAction(CollectionActionEnum value)

withCollectionName

public SubscriptionManagementRequest withCollectionName(java.lang.String value)

withExtendedHeaders

public SubscriptionManagementRequest withExtendedHeaders(ExtendedHeadersType value)

Overrides:

withExtendedHeaders in class RequestMessageType

withMessageId

public SubscriptionManagementRequest withMessageId(java.lang.String value)

Overrides:

withMessageId in class RequestMessageType