org.mitre.taxii.messages.xml11

Class SubscriptionManagementResponse

java.lang.Object

org.mitre.taxii.messages.xml11.MessageType

org.mitre.taxii.messages.xml11.ResponseMessageType

org.mitre.taxii.messages.xml11.SubscriptionManagementResponse

All Implemented Interfaces:

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

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

Indicates a successful response to a Collection Management Request message.

Java class for TAXIISubscriptionManagementResponseType complex type.

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

 <complexType name="TAXIISubscriptionManagementResponseType">
   <complexContent>
     <extension base="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}ResponseMessageType">
       <sequence>
         <element name="Message" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Subscription" type="{http://taxii.mitre.org/messages/taxii_xml_binding-1.1}SubscriptionRecordType" 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" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	collectionName
protected java.lang.String	message
protected Signature	signature
protected java.util.List<SubscriptionRecordType>	subscriptions

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
SubscriptionManagementResponse() Default no-arg constructor
SubscriptionManagementResponse(ExtendedHeadersType extendedHeaders, java.lang.String messageId, java.lang.String inResponseTo, java.lang.String message, java.util.List<SubscriptionRecordType> subscriptions, 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.
java.lang.String	getMessage() Gets the value of the message property.
Signature	getSignature() An XML Digital Signature scoped to this message.
java.util.List<SubscriptionRecordType>	getSubscriptions() Gets the value of the subscriptions 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	setMessage(java.lang.String value) Sets the value of the message property.
void	setSignature(Signature value) Sets the value of the signature property.
SubscriptionManagementResponse	withCollectionName(java.lang.String value)
SubscriptionManagementResponse	withExtendedHeaders(ExtendedHeadersType value)
SubscriptionManagementResponse	withInResponseTo(java.lang.String value)
SubscriptionManagementResponse	withMessage(java.lang.String value)
SubscriptionManagementResponse	withMessageId(java.lang.String value)
SubscriptionManagementResponse	withSignature(Signature value)
SubscriptionManagementResponse	withSubscriptions(java.util.Collection<SubscriptionRecordType> values)
SubscriptionManagementResponse	withSubscriptions(SubscriptionRecordType... values)

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

message

protected java.lang.String message

subscriptions

protected java.util.List<SubscriptionRecordType> subscriptions

signature

protected Signature signature

collectionName

protected java.lang.String collectionName

Constructor Detail

SubscriptionManagementResponse

public SubscriptionManagementResponse()

Default no-arg constructor

SubscriptionManagementResponse

public SubscriptionManagementResponse(ExtendedHeadersType extendedHeaders,
                              java.lang.String messageId,
                              java.lang.String inResponseTo,
                              java.lang.String message,
                              java.util.List<SubscriptionRecordType> subscriptions,
                              Signature signature,
                              java.lang.String collectionName)

Fully-initialising value constructor

Method Detail

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

getSubscriptions

public java.util.List<SubscriptionRecordType> getSubscriptions()

Gets the value of the subscriptions 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 subscriptions property.

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

    getSubscriptions().add(newItem);
 

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

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 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

withMessage

public SubscriptionManagementResponse withMessage(java.lang.String value)

withSubscriptions

public SubscriptionManagementResponse withSubscriptions(SubscriptionRecordType... values)

withSubscriptions

public SubscriptionManagementResponse withSubscriptions(java.util.Collection<SubscriptionRecordType> values)

withSignature

public SubscriptionManagementResponse withSignature(Signature value)

withCollectionName

public SubscriptionManagementResponse withCollectionName(java.lang.String value)

withInResponseTo

public SubscriptionManagementResponse withInResponseTo(java.lang.String value)

Overrides:

withInResponseTo in class ResponseMessageType

withExtendedHeaders

public SubscriptionManagementResponse withExtendedHeaders(ExtendedHeadersType value)

Overrides:

withExtendedHeaders in class ResponseMessageType

withMessageId

public SubscriptionManagementResponse withMessageId(java.lang.String value)

Overrides:

withMessageId in class ResponseMessageType