org.mitre.cybox.objects.NetworkPacket Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of stix Show documentation
Show all versions of stix Show documentation
The Java bindings for STIX v.1.2.0.2
The newest version!
/**
* Copyright (c) 2015, The MITRE Corporation. All rights reserved.
* See LICENSE for complete terms.
*/
//
// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.2.5-2
// See http://java.sun.com/xml/jaxb
// Any modifications to this file will be lost upon recompilation of the source schema.
// Generated on: 2015.07.01 at 03:19:53 PM EDT
//
package org.mitre.cybox.objects;
import java.io.StringReader;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBElement;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import javax.xml.namespace.QName;
import javax.xml.transform.stream.StreamSource;
import org.jvnet.jaxb2_commons.lang.Equals;
import org.jvnet.jaxb2_commons.lang.EqualsStrategy;
import org.jvnet.jaxb2_commons.lang.HashCode;
import org.jvnet.jaxb2_commons.lang.HashCodeStrategy;
import org.jvnet.jaxb2_commons.lang.JAXBEqualsStrategy;
import org.jvnet.jaxb2_commons.lang.JAXBHashCodeStrategy;
import org.jvnet.jaxb2_commons.lang.JAXBToStringStrategy;
import org.jvnet.jaxb2_commons.lang.ToString;
import org.jvnet.jaxb2_commons.lang.ToStringStrategy;
import org.jvnet.jaxb2_commons.locator.ObjectLocator;
import org.jvnet.jaxb2_commons.locator.util.LocatorUtils;
import org.mitre.cybox.common_2.CustomPropertiesType;
import org.mitre.cybox.common_2.ObjectPropertiesType;
import org.mitre.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;
/**
* The NetworkPacketObjectType's definition of a network packet is based on the TCP/IP model/Internet protocol suite. In the TCP/IP stack, "packet" is generally defined as IP header plus payload, but we also include the LinkLayer from the OSI model, which defines the physical network interfaces and routing protocols. Protocol fields are provided but requirements are not enforced/captured; all fields are optional.
*
* Java class for NetworkPacketObjectType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="NetworkPacketObjectType">
* <complexContent>
* <extension base="{http://cybox.mitre.org/common-2}ObjectPropertiesType">
* <choice>
* <element name="Link_Layer" type="{http://cybox.mitre.org/objects#PacketObject-2}LinkLayerType" minOccurs="0"/>
* <element name="Internet_Layer" type="{http://cybox.mitre.org/objects#PacketObject-2}InternetLayerType" minOccurs="0"/>
* <element name="Transport_Layer" type="{http://cybox.mitre.org/objects#PacketObject-2}TransportLayerType" minOccurs="0"/>
* </choice>
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "NetworkPacketObjectType", propOrder = { "transportLayer",
"internetLayer", "linkLayer" })
@XmlRootElement(name = "Network_Packet")
public class NetworkPacket extends ObjectPropertiesType implements Equals,
HashCode, ToString {
@XmlElement(name = "Transport_Layer")
protected TransportLayerType transportLayer;
@XmlElement(name = "Internet_Layer")
protected InternetLayerType internetLayer;
@XmlElement(name = "Link_Layer")
protected LinkLayerType linkLayer;
/**
* Default no-arg constructor
*
*/
public NetworkPacket() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public NetworkPacket(final CustomPropertiesType customProperties,
final QName objectReference,
final TransportLayerType transportLayer,
final InternetLayerType internetLayer, final LinkLayerType linkLayer) {
super(customProperties, objectReference);
this.transportLayer = transportLayer;
this.internetLayer = internetLayer;
this.linkLayer = linkLayer;
}
/**
* Gets the value of the transportLayer property.
*
* @return
* possible object is
* {@link TransportLayerType }
*
*/
public TransportLayerType getTransportLayer() {
return transportLayer;
}
/**
* Sets the value of the transportLayer property.
*
* @param value
* allowed object is
* {@link TransportLayerType }
*
*/
public void setTransportLayer(TransportLayerType value) {
this.transportLayer = value;
}
/**
* Gets the value of the internetLayer property.
*
* @return
* possible object is
* {@link InternetLayerType }
*
*/
public InternetLayerType getInternetLayer() {
return internetLayer;
}
/**
* Sets the value of the internetLayer property.
*
* @param value
* allowed object is
* {@link InternetLayerType }
*
*/
public void setInternetLayer(InternetLayerType value) {
this.internetLayer = value;
}
/**
* Gets the value of the linkLayer property.
*
* @return
* possible object is
* {@link LinkLayerType }
*
*/
public LinkLayerType getLinkLayer() {
return linkLayer;
}
/**
* Sets the value of the linkLayer property.
*
* @param value
* allowed object is
* {@link LinkLayerType }
*
*/
public void setLinkLayer(LinkLayerType value) {
this.linkLayer = value;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof NetworkPacket)) {
return false;
}
if (this == object) {
return true;
}
if (!super.equals(thisLocator, thatLocator, object, strategy)) {
return false;
}
final NetworkPacket that = ((NetworkPacket) object);
{
TransportLayerType lhsTransportLayer;
lhsTransportLayer = this.getTransportLayer();
TransportLayerType rhsTransportLayer;
rhsTransportLayer = that.getTransportLayer();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"transportLayer", lhsTransportLayer),
LocatorUtils.property(thatLocator, "transportLayer",
rhsTransportLayer), lhsTransportLayer,
rhsTransportLayer)) {
return false;
}
}
{
InternetLayerType lhsInternetLayer;
lhsInternetLayer = this.getInternetLayer();
InternetLayerType rhsInternetLayer;
rhsInternetLayer = that.getInternetLayer();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"internetLayer", lhsInternetLayer), LocatorUtils.property(
thatLocator, "internetLayer", rhsInternetLayer),
lhsInternetLayer, rhsInternetLayer)) {
return false;
}
}
{
LinkLayerType lhsLinkLayer;
lhsLinkLayer = this.getLinkLayer();
LinkLayerType rhsLinkLayer;
rhsLinkLayer = that.getLinkLayer();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"linkLayer", lhsLinkLayer), LocatorUtils.property(
thatLocator, "linkLayer", rhsLinkLayer), lhsLinkLayer,
rhsLinkLayer)) {
return false;
}
}
return true;
}
public boolean equals(Object object) {
final EqualsStrategy strategy = JAXBEqualsStrategy.INSTANCE;
return equals(null, null, object, strategy);
}
public int hashCode(ObjectLocator locator, HashCodeStrategy strategy) {
int currentHashCode = super.hashCode(locator, strategy);
{
TransportLayerType theTransportLayer;
theTransportLayer = this.getTransportLayer();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"transportLayer", theTransportLayer), currentHashCode,
theTransportLayer);
}
{
InternetLayerType theInternetLayer;
theInternetLayer = this.getInternetLayer();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"internetLayer", theInternetLayer), currentHashCode,
theInternetLayer);
}
{
LinkLayerType theLinkLayer;
theLinkLayer = this.getLinkLayer();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "linkLayer", theLinkLayer),
currentHashCode, theLinkLayer);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public NetworkPacket withTransportLayer(TransportLayerType value) {
setTransportLayer(value);
return this;
}
public NetworkPacket withInternetLayer(InternetLayerType value) {
setInternetLayer(value);
return this;
}
public NetworkPacket withLinkLayer(LinkLayerType value) {
setLinkLayer(value);
return this;
}
@Override
public NetworkPacket withCustomProperties(CustomPropertiesType value) {
setCustomProperties(value);
return this;
}
@Override
public NetworkPacket withObjectReference(QName value) {
setObjectReference(value);
return this;
}
public String toString() {
final ToStringStrategy strategy = JAXBToStringStrategy.INSTANCE;
final StringBuilder buffer = new StringBuilder();
append(null, buffer, strategy);
return buffer.toString();
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
ToStringStrategy strategy) {
strategy.appendStart(locator, this, buffer);
appendFields(locator, buffer, strategy);
strategy.appendEnd(locator, this, buffer);
return buffer;
}
public StringBuilder appendFields(ObjectLocator locator,
StringBuilder buffer, ToStringStrategy strategy) {
super.appendFields(locator, buffer, strategy);
{
TransportLayerType theTransportLayer;
theTransportLayer = this.getTransportLayer();
strategy.appendField(locator, this, "transportLayer", buffer,
theTransportLayer);
}
{
InternetLayerType theInternetLayer;
theInternetLayer = this.getInternetLayer();
strategy.appendField(locator, this, "internetLayer", buffer,
theInternetLayer);
}
{
LinkLayerType theLinkLayer;
theLinkLayer = this.getLinkLayer();
strategy.appendField(locator, this, "linkLayer", buffer,
theLinkLayer);
}
return buffer;
}
/**
* Returns A Document representation of this instance that is not formatted.
*
* @return The Document representation for this instance.
*/
public org.w3c.dom.Document toDocument() {
return toDocument(false);
}
/**
* Returns A Document representation for this instance.
*
* @param prettyPrint
* True for pretty print, otherwise false
*
* @return The Document representation for this instance.
*/
public org.w3c.dom.Document toDocument(boolean prettyPrint) {
return DocumentUtilities.toDocument(toJAXBElement(), prettyPrint);
}
/**
* Returns JAXBElement for this instance.
*
* @return The JAXBElement for this instance.
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
public JAXBElement toJAXBElement() {
QName qualifiedName = STIXSchema.getQualifiedName(this);
return new JAXBElement(qualifiedName, NetworkPacket.class, this);
}
/**
* Returns String representation of this instance that is not formatted.
*
* @return The String containing the XML mark-up.
*/
public String toXMLString() {
return toXMLString(false);
}
/**
* Returns XML String for JAXB Document Object Model object.
*
* @param prettyPrint
* True for pretty print, otherwise false
*
* @return The String containing the XML mark-up.
*/
public String toXMLString(boolean prettyPrint) {
return DocumentUtilities.toXMLString(toDocument(), prettyPrint);
}
/**
* Creates NetworkPacket instance for XML String
*
* @param text
* XML String for the document
* @return The NetworkPacket instance for the passed XML String
*/
public static NetworkPacket fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(NetworkPacket.class
.getPackage().getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (NetworkPacket) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this NetworkPacket instance
* Returning true indicating a successful validation, false if not.
*
* @return boolean True If it validates against the schema
* @throws SAXException
* If the a validation ErrorHandler has not been set, and
* validation throws a SAXException
*/
public boolean validate() throws SAXException {
return STIXSchema.getInstance().validate(toXMLString());
}
}