org.mitre.cybox.objects.SocketAddress 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
/**
* 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.06.23 at 10:59:44 AM 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;
/**
* The SocketAddressObjectType specifies an identifier for a network host (IP address or Hostname) and port number pair.
*
* Java class for SocketAddressObjectType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="SocketAddressObjectType">
* <complexContent>
* <extension base="{http://cybox.mitre.org/common-2}ObjectPropertiesType">
* <sequence>
* <choice>
* <element name="IP_Address" type="{http://cybox.mitre.org/objects#AddressObject-2}AddressObjectType" minOccurs="0"/>
* <element name="Hostname" type="{http://cybox.mitre.org/objects#HostnameObject-1}HostnameObjectType" minOccurs="0"/>
* </choice>
* <element name="Port" type="{http://cybox.mitre.org/objects#PortObject-2}PortObjectType" minOccurs="0"/>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "SocketAddressObjectType", namespace = "http://cybox.mitre.org/objects#SocketAddressObject-1", propOrder = {
"hostname", "ipAddress", "port" })
@XmlRootElement(name = "Socket_Address", namespace = "http://cybox.mitre.org/objects#SocketAddressObject-1")
public class SocketAddress extends ObjectPropertiesType implements Equals,
HashCode, ToString {
@XmlElement(name = "Hostname")
protected Hostname hostname;
@XmlElement(name = "IP_Address")
protected Address ipAddress;
@XmlElement(name = "Port")
protected Port port;
/**
* Default no-arg constructor
*
*/
public SocketAddress() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public SocketAddress(final CustomPropertiesType customProperties,
final QName objectReference, final Hostname hostname,
final Address ipAddress, final Port port) {
super(customProperties, objectReference);
this.hostname = hostname;
this.ipAddress = ipAddress;
this.port = port;
}
/**
* Gets the value of the hostname property.
*
* @return
* possible object is
* {@link Hostname }
*
*/
public Hostname getHostname() {
return hostname;
}
/**
* Sets the value of the hostname property.
*
* @param value
* allowed object is
* {@link Hostname }
*
*/
public void setHostname(Hostname value) {
this.hostname = value;
}
/**
* Gets the value of the ipAddress property.
*
* @return
* possible object is
* {@link Address }
*
*/
public Address getIPAddress() {
return ipAddress;
}
/**
* Sets the value of the ipAddress property.
*
* @param value
* allowed object is
* {@link Address }
*
*/
public void setIPAddress(Address value) {
this.ipAddress = value;
}
/**
* Gets the value of the port property.
*
* @return
* possible object is
* {@link Port }
*
*/
public Port getPort() {
return port;
}
/**
* Sets the value of the port property.
*
* @param value
* allowed object is
* {@link Port }
*
*/
public void setPort(Port value) {
this.port = value;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof SocketAddress)) {
return false;
}
if (this == object) {
return true;
}
if (!super.equals(thisLocator, thatLocator, object, strategy)) {
return false;
}
final SocketAddress that = ((SocketAddress) object);
{
Hostname lhsHostname;
lhsHostname = this.getHostname();
Hostname rhsHostname;
rhsHostname = that.getHostname();
if (!strategy
.equals(LocatorUtils.property(thisLocator, "hostname",
lhsHostname), LocatorUtils.property(thatLocator,
"hostname", rhsHostname), lhsHostname, rhsHostname)) {
return false;
}
}
{
Address lhsIPAddress;
lhsIPAddress = this.getIPAddress();
Address rhsIPAddress;
rhsIPAddress = that.getIPAddress();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"ipAddress", lhsIPAddress), LocatorUtils.property(
thatLocator, "ipAddress", rhsIPAddress), lhsIPAddress,
rhsIPAddress)) {
return false;
}
}
{
Port lhsPort;
lhsPort = this.getPort();
Port rhsPort;
rhsPort = that.getPort();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "port", lhsPort),
LocatorUtils.property(thatLocator, "port", rhsPort),
lhsPort, rhsPort)) {
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);
{
Hostname theHostname;
theHostname = this.getHostname();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "hostname", theHostname),
currentHashCode, theHostname);
}
{
Address theIPAddress;
theIPAddress = this.getIPAddress();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "ipAddress", theIPAddress),
currentHashCode, theIPAddress);
}
{
Port thePort;
thePort = this.getPort();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "port", thePort),
currentHashCode, thePort);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public SocketAddress withHostname(Hostname value) {
setHostname(value);
return this;
}
public SocketAddress withIPAddress(Address value) {
setIPAddress(value);
return this;
}
public SocketAddress withPort(Port value) {
setPort(value);
return this;
}
@Override
public SocketAddress withCustomProperties(CustomPropertiesType value) {
setCustomProperties(value);
return this;
}
@Override
public SocketAddress 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);
{
Hostname theHostname;
theHostname = this.getHostname();
strategy.appendField(locator, this, "hostname", buffer, theHostname);
}
{
Address theIPAddress;
theIPAddress = this.getIPAddress();
strategy.appendField(locator, this, "ipAddress", buffer,
theIPAddress);
}
{
Port thePort;
thePort = this.getPort();
strategy.appendField(locator, this, "port", buffer, thePort);
}
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, SocketAddress.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 SocketAddress instance for XML String
*
* @param text
* XML String for the document
* @return The SocketAddress instance for the passed XML String
*/
public static SocketAddress fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(SocketAddress.class
.getPackage().getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (SocketAddress) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this SocketAddress instance
* Returning true indicating a successful validation, false if not.
*
* @return boolean
*/
public boolean validate() {
return STIXSchema.getInstance().validate(toXMLString());
}
}