org.mitre.cybox.objects.WindowsHook 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.07.01 at 03:30:29 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.NonNegativeIntegerObjectPropertyType;
import org.mitre.cybox.common_2.ObjectPropertiesType;
import org.mitre.cybox.common_2.StringObjectPropertyType;
import org.mitre.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;
/**
* For more information please see http://msdn.microsoft.com/en-us/library/windows/desktop/ms644990(v=vs.85).aspx.
*
* Java class for WindowsHookObjectType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="WindowsHookObjectType">
* <complexContent>
* <extension base="{http://cybox.mitre.org/common-2}ObjectPropertiesType">
* <sequence>
* <element name="Type" type="{http://cybox.mitre.org/objects#WinHookObject-1}WinHookType" minOccurs="0"/>
* <element name="Handle" type="{http://cybox.mitre.org/objects#WinHandleObject-2}WindowsHandleObjectType" minOccurs="0"/>
* <element name="Hooking_Function_Name" type="{http://cybox.mitre.org/common-2}StringObjectPropertyType" minOccurs="0"/>
* <element name="Hooking_Module" type="{http://cybox.mitre.org/objects#LibraryObject-2}LibraryObjectType" minOccurs="0"/>
* <element name="Thread_ID" type="{http://cybox.mitre.org/common-2}NonNegativeIntegerObjectPropertyType" minOccurs="0"/>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "WindowsHookObjectType", namespace = "http://cybox.mitre.org/objects#WinHookObject-1", propOrder = {
"type", "handle", "hookingFunctionName", "hookingModule", "threadID" })
@XmlRootElement(name = "Windows_Hook", namespace = "http://cybox.mitre.org/objects#WinHookObject-1")
public class WindowsHook extends ObjectPropertiesType implements Equals,
HashCode, ToString {
@XmlElement(name = "Type")
protected WinHookType type;
@XmlElement(name = "Handle")
protected WindowsHandle handle;
@XmlElement(name = "Hooking_Function_Name")
protected StringObjectPropertyType hookingFunctionName;
@XmlElement(name = "Hooking_Module")
protected Library hookingModule;
@XmlElement(name = "Thread_ID")
protected NonNegativeIntegerObjectPropertyType threadID;
/**
* Default no-arg constructor
*
*/
public WindowsHook() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public WindowsHook(final CustomPropertiesType customProperties,
final QName objectReference, final WinHookType type,
final WindowsHandle handle,
final StringObjectPropertyType hookingFunctionName,
final Library hookingModule,
final NonNegativeIntegerObjectPropertyType threadID) {
super(customProperties, objectReference);
this.type = type;
this.handle = handle;
this.hookingFunctionName = hookingFunctionName;
this.hookingModule = hookingModule;
this.threadID = threadID;
}
/**
* Gets the value of the type property.
*
* @return
* possible object is
* {@link WinHookType }
*
*/
public WinHookType getType() {
return type;
}
/**
* Sets the value of the type property.
*
* @param value
* allowed object is
* {@link WinHookType }
*
*/
public void setType(WinHookType value) {
this.type = value;
}
/**
* Gets the value of the handle property.
*
* @return
* possible object is
* {@link WindowsHandle }
*
*/
public WindowsHandle getHandle() {
return handle;
}
/**
* Sets the value of the handle property.
*
* @param value
* allowed object is
* {@link WindowsHandle }
*
*/
public void setHandle(WindowsHandle value) {
this.handle = value;
}
/**
* Gets the value of the hookingFunctionName property.
*
* @return
* possible object is
* {@link StringObjectPropertyType }
*
*/
public StringObjectPropertyType getHookingFunctionName() {
return hookingFunctionName;
}
/**
* Sets the value of the hookingFunctionName property.
*
* @param value
* allowed object is
* {@link StringObjectPropertyType }
*
*/
public void setHookingFunctionName(StringObjectPropertyType value) {
this.hookingFunctionName = value;
}
/**
* Gets the value of the hookingModule property.
*
* @return
* possible object is
* {@link Library }
*
*/
public Library getHookingModule() {
return hookingModule;
}
/**
* Sets the value of the hookingModule property.
*
* @param value
* allowed object is
* {@link Library }
*
*/
public void setHookingModule(Library value) {
this.hookingModule = value;
}
/**
* Gets the value of the threadID property.
*
* @return
* possible object is
* {@link NonNegativeIntegerObjectPropertyType }
*
*/
public NonNegativeIntegerObjectPropertyType getThreadID() {
return threadID;
}
/**
* Sets the value of the threadID property.
*
* @param value
* allowed object is
* {@link NonNegativeIntegerObjectPropertyType }
*
*/
public void setThreadID(NonNegativeIntegerObjectPropertyType value) {
this.threadID = value;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof WindowsHook)) {
return false;
}
if (this == object) {
return true;
}
if (!super.equals(thisLocator, thatLocator, object, strategy)) {
return false;
}
final WindowsHook that = ((WindowsHook) object);
{
WinHookType lhsType;
lhsType = this.getType();
WinHookType rhsType;
rhsType = that.getType();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "type", lhsType),
LocatorUtils.property(thatLocator, "type", rhsType),
lhsType, rhsType)) {
return false;
}
}
{
WindowsHandle lhsHandle;
lhsHandle = this.getHandle();
WindowsHandle rhsHandle;
rhsHandle = that.getHandle();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "handle", lhsHandle),
LocatorUtils.property(thatLocator, "handle", rhsHandle),
lhsHandle, rhsHandle)) {
return false;
}
}
{
StringObjectPropertyType lhsHookingFunctionName;
lhsHookingFunctionName = this.getHookingFunctionName();
StringObjectPropertyType rhsHookingFunctionName;
rhsHookingFunctionName = that.getHookingFunctionName();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"hookingFunctionName", lhsHookingFunctionName),
LocatorUtils.property(thatLocator, "hookingFunctionName",
rhsHookingFunctionName), lhsHookingFunctionName,
rhsHookingFunctionName)) {
return false;
}
}
{
Library lhsHookingModule;
lhsHookingModule = this.getHookingModule();
Library rhsHookingModule;
rhsHookingModule = that.getHookingModule();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"hookingModule", lhsHookingModule), LocatorUtils.property(
thatLocator, "hookingModule", rhsHookingModule),
lhsHookingModule, rhsHookingModule)) {
return false;
}
}
{
NonNegativeIntegerObjectPropertyType lhsThreadID;
lhsThreadID = this.getThreadID();
NonNegativeIntegerObjectPropertyType rhsThreadID;
rhsThreadID = that.getThreadID();
if (!strategy
.equals(LocatorUtils.property(thisLocator, "threadID",
lhsThreadID), LocatorUtils.property(thatLocator,
"threadID", rhsThreadID), lhsThreadID, rhsThreadID)) {
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);
{
WinHookType theType;
theType = this.getType();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "type", theType),
currentHashCode, theType);
}
{
WindowsHandle theHandle;
theHandle = this.getHandle();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "handle", theHandle),
currentHashCode, theHandle);
}
{
StringObjectPropertyType theHookingFunctionName;
theHookingFunctionName = this.getHookingFunctionName();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"hookingFunctionName", theHookingFunctionName),
currentHashCode, theHookingFunctionName);
}
{
Library theHookingModule;
theHookingModule = this.getHookingModule();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"hookingModule", theHookingModule), currentHashCode,
theHookingModule);
}
{
NonNegativeIntegerObjectPropertyType theThreadID;
theThreadID = this.getThreadID();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "threadID", theThreadID),
currentHashCode, theThreadID);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public WindowsHook withType(WinHookType value) {
setType(value);
return this;
}
public WindowsHook withHandle(WindowsHandle value) {
setHandle(value);
return this;
}
public WindowsHook withHookingFunctionName(StringObjectPropertyType value) {
setHookingFunctionName(value);
return this;
}
public WindowsHook withHookingModule(Library value) {
setHookingModule(value);
return this;
}
public WindowsHook withThreadID(NonNegativeIntegerObjectPropertyType value) {
setThreadID(value);
return this;
}
@Override
public WindowsHook withCustomProperties(CustomPropertiesType value) {
setCustomProperties(value);
return this;
}
@Override
public WindowsHook 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);
{
WinHookType theType;
theType = this.getType();
strategy.appendField(locator, this, "type", buffer, theType);
}
{
WindowsHandle theHandle;
theHandle = this.getHandle();
strategy.appendField(locator, this, "handle", buffer, theHandle);
}
{
StringObjectPropertyType theHookingFunctionName;
theHookingFunctionName = this.getHookingFunctionName();
strategy.appendField(locator, this, "hookingFunctionName", buffer,
theHookingFunctionName);
}
{
Library theHookingModule;
theHookingModule = this.getHookingModule();
strategy.appendField(locator, this, "hookingModule", buffer,
theHookingModule);
}
{
NonNegativeIntegerObjectPropertyType theThreadID;
theThreadID = this.getThreadID();
strategy.appendField(locator, this, "threadID", buffer, theThreadID);
}
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, WindowsHook.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 WindowsHook instance for XML String
*
* @param text
* XML String for the document
* @return The WindowsHook instance for the passed XML String
*/
public static WindowsHook fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(WindowsHook.class
.getPackage().getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (WindowsHook) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this WindowsHook 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());
}
}