org.mitre.cybox.objects.UnixFile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
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.ByteRunsType;
import org.mitre.cybox.common_2.CipherType;
import org.mitre.cybox.common_2.CustomPropertiesType;
import org.mitre.cybox.common_2.DateTimeObjectPropertyType;
import org.mitre.cybox.common_2.DigitalSignaturesType;
import org.mitre.cybox.common_2.DoubleObjectPropertyType;
import org.mitre.cybox.common_2.ExtractedFeaturesType;
import org.mitre.cybox.common_2.HashListType;
import org.mitre.cybox.common_2.HexBinaryObjectPropertyType;
import org.mitre.cybox.common_2.StringObjectPropertyType;
import org.mitre.cybox.common_2.UnsignedLongObjectPropertyType;
import org.mitre.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;

/**
 * The UnixFileObjectType type is intended to characterize Unix files.
 * 
 * Java class for UnixFileObjectType complex type.
 * 
 * 
The following schema fragment specifies the expected content contained within this class.
 * 
 * 
 * <complexType name="UnixFileObjectType">
 *   <complexContent>
 *     <extension base="{http://cybox.mitre.org/objects#FileObject-2}FileObjectType">
 *       <sequence>
 *         <element name="Group_Owner" type="{http://cybox.mitre.org/common-2}StringObjectPropertyType" minOccurs="0"/>
 *         <element name="INode" type="{http://cybox.mitre.org/common-2}UnsignedLongObjectPropertyType" minOccurs="0"/>
 *         <element name="Type" type="{http://cybox.mitre.org/objects#UnixFileObject-2}UnixFileType" minOccurs="0"/>
 *       </sequence>
 *     </extension>
 *   </complexContent>
 * </complexType>
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "UnixFileObjectType", namespace = "http://cybox.mitre.org/objects#UnixFileObject-2", propOrder = {
		"groupOwner", "iNode", "type" })
@XmlRootElement(name = "Unix_File", namespace = "http://cybox.mitre.org/objects#UnixFileObject-2")
public class UnixFile extends FileObjectType implements Equals, HashCode,
		ToString {

	@XmlElement(name = "Group_Owner")
	protected StringObjectPropertyType groupOwner;
	@XmlElement(name = "INode")
	protected UnsignedLongObjectPropertyType iNode;
	@XmlElement(name = "Type")
	protected UnixFileType type;

	/**
	 * Default no-arg constructor
	 * 
	 */
	public UnixFile() {
		super();
	}

	/**
	 * Fully-initialising value constructor
	 * 
	 */
	public UnixFile(final CustomPropertiesType customProperties,
			final QName objectReference,
			final StringObjectPropertyType fileName,
			final FilePathType filePath,
			final StringObjectPropertyType devicePath,
			final StringObjectPropertyType fullPath,
			final StringObjectPropertyType fileExtension,
			final UnsignedLongObjectPropertyType sizeInBytes,
			final HexBinaryObjectPropertyType magicNumber,
			final StringObjectPropertyType fileFormat,
			final HashListType hashes,
			final DigitalSignaturesType digitalSignatures,
			final DateTimeObjectPropertyType modifiedTime,
			final DateTimeObjectPropertyType accessedTime,
			final DateTimeObjectPropertyType createdTime,
			final FileAttributeType fileAttributesList,
			final FilePermissionsType permissions,
			final StringObjectPropertyType userOwner,
			final PackerListType packerList,
			final DoubleObjectPropertyType peakEntropy,
			final SymLinksListType symLinks, final ByteRunsType byteRuns,
			final ExtractedFeaturesType extractedFeatures,
			final CipherType encryptionAlgorithm,
			final StringObjectPropertyType decryptionKey,
			final StringObjectPropertyType compressionMethod,
			final StringObjectPropertyType compressionVersion,
			final StringObjectPropertyType compressionComment,
			final Boolean isPacked, final Boolean isMasqueraded,
			final StringObjectPropertyType groupOwner,
			final UnsignedLongObjectPropertyType iNode, final UnixFileType type) {
		super(customProperties, objectReference, fileName, filePath,
				devicePath, fullPath, fileExtension, sizeInBytes, magicNumber,
				fileFormat, hashes, digitalSignatures, modifiedTime,
				accessedTime, createdTime, fileAttributesList, permissions,
				userOwner, packerList, peakEntropy, symLinks, byteRuns,
				extractedFeatures, encryptionAlgorithm, decryptionKey,
				compressionMethod, compressionVersion, compressionComment,
				isPacked, isMasqueraded);
		this.groupOwner = groupOwner;
		this.iNode = iNode;
		this.type = type;
	}

	/**
	 * Gets the value of the groupOwner property.
	 * 
	 * @return
	 *     possible object is
	 *     {@link StringObjectPropertyType }
	 *     
	 */
	public StringObjectPropertyType getGroupOwner() {
		return groupOwner;
	}

	/**
	 * Sets the value of the groupOwner property.
	 * 
	 * @param value
	 *     allowed object is
	 *     {@link StringObjectPropertyType }
	 *     
	 */
	public void setGroupOwner(StringObjectPropertyType value) {
		this.groupOwner = value;
	}

	/**
	 * Gets the value of the iNode property.
	 * 
	 * @return
	 *     possible object is
	 *     {@link UnsignedLongObjectPropertyType }
	 *     
	 */
	public UnsignedLongObjectPropertyType getINode() {
		return iNode;
	}

	/**
	 * Sets the value of the iNode property.
	 * 
	 * @param value
	 *     allowed object is
	 *     {@link UnsignedLongObjectPropertyType }
	 *     
	 */
	public void setINode(UnsignedLongObjectPropertyType value) {
		this.iNode = value;
	}

	/**
	 * Gets the value of the type property.
	 * 
	 * @return
	 *     possible object is
	 *     {@link UnixFileType }
	 *     
	 */
	public UnixFileType getType() {
		return type;
	}

	/**
	 * Sets the value of the type property.
	 * 
	 * @param value
	 *     allowed object is
	 *     {@link UnixFileType }
	 *     
	 */
	public void setType(UnixFileType value) {
		this.type = value;
	}

	public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
			Object object, EqualsStrategy strategy) {
		if (!(object instanceof UnixFile)) {
			return false;
		}
		if (this == object) {
			return true;
		}
		if (!super.equals(thisLocator, thatLocator, object, strategy)) {
			return false;
		}
		final UnixFile that = ((UnixFile) object);
		{
			StringObjectPropertyType lhsGroupOwner;
			lhsGroupOwner = this.getGroupOwner();
			StringObjectPropertyType rhsGroupOwner;
			rhsGroupOwner = that.getGroupOwner();
			if (!strategy.equals(LocatorUtils.property(thisLocator,
					"groupOwner", lhsGroupOwner), LocatorUtils.property(
					thatLocator, "groupOwner", rhsGroupOwner), lhsGroupOwner,
					rhsGroupOwner)) {
				return false;
			}
		}
		{
			UnsignedLongObjectPropertyType lhsINode;
			lhsINode = this.getINode();
			UnsignedLongObjectPropertyType rhsINode;
			rhsINode = that.getINode();
			if (!strategy.equals(
					LocatorUtils.property(thisLocator, "iNode", lhsINode),
					LocatorUtils.property(thatLocator, "iNode", rhsINode),
					lhsINode, rhsINode)) {
				return false;
			}
		}
		{
			UnixFileType lhsType;
			lhsType = this.getType();
			UnixFileType rhsType;
			rhsType = that.getType();
			if (!strategy.equals(
					LocatorUtils.property(thisLocator, "type", lhsType),
					LocatorUtils.property(thatLocator, "type", rhsType),
					lhsType, rhsType)) {
				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);
		{
			StringObjectPropertyType theGroupOwner;
			theGroupOwner = this.getGroupOwner();
			currentHashCode = strategy
					.hashCode(LocatorUtils.property(locator, "groupOwner",
							theGroupOwner), currentHashCode, theGroupOwner);
		}
		{
			UnsignedLongObjectPropertyType theINode;
			theINode = this.getINode();
			currentHashCode = strategy.hashCode(
					LocatorUtils.property(locator, "iNode", theINode),
					currentHashCode, theINode);
		}
		{
			UnixFileType theType;
			theType = this.getType();
			currentHashCode = strategy.hashCode(
					LocatorUtils.property(locator, "type", theType),
					currentHashCode, theType);
		}
		return currentHashCode;
	}

	public int hashCode() {
		final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
		return this.hashCode(null, strategy);
	}

	public UnixFile withGroupOwner(StringObjectPropertyType value) {
		setGroupOwner(value);
		return this;
	}

	public UnixFile withINode(UnsignedLongObjectPropertyType value) {
		setINode(value);
		return this;
	}

	public UnixFile withType(UnixFileType value) {
		setType(value);
		return this;
	}

	@Override
	public UnixFile withFileName(StringObjectPropertyType value) {
		setFileName(value);
		return this;
	}

	@Override
	public UnixFile withFilePath(FilePathType value) {
		setFilePath(value);
		return this;
	}

	@Override
	public UnixFile withDevicePath(StringObjectPropertyType value) {
		setDevicePath(value);
		return this;
	}

	@Override
	public UnixFile withFullPath(StringObjectPropertyType value) {
		setFullPath(value);
		return this;
	}

	@Override
	public UnixFile withFileExtension(StringObjectPropertyType value) {
		setFileExtension(value);
		return this;
	}

	@Override
	public UnixFile withSizeInBytes(UnsignedLongObjectPropertyType value) {
		setSizeInBytes(value);
		return this;
	}

	@Override
	public UnixFile withMagicNumber(HexBinaryObjectPropertyType value) {
		setMagicNumber(value);
		return this;
	}

	@Override
	public UnixFile withFileFormat(StringObjectPropertyType value) {
		setFileFormat(value);
		return this;
	}

	@Override
	public UnixFile withHashes(HashListType value) {
		setHashes(value);
		return this;
	}

	@Override
	public UnixFile withDigitalSignatures(DigitalSignaturesType value) {
		setDigitalSignatures(value);
		return this;
	}

	@Override
	public UnixFile withModifiedTime(DateTimeObjectPropertyType value) {
		setModifiedTime(value);
		return this;
	}

	@Override
	public UnixFile withAccessedTime(DateTimeObjectPropertyType value) {
		setAccessedTime(value);
		return this;
	}

	@Override
	public UnixFile withCreatedTime(DateTimeObjectPropertyType value) {
		setCreatedTime(value);
		return this;
	}

	@Override
	public UnixFile withFileAttributesList(FileAttributeType value) {
		setFileAttributesList(value);
		return this;
	}

	@Override
	public UnixFile withPermissions(FilePermissionsType value) {
		setPermissions(value);
		return this;
	}

	@Override
	public UnixFile withUserOwner(StringObjectPropertyType value) {
		setUserOwner(value);
		return this;
	}

	@Override
	public UnixFile withPackerList(PackerListType value) {
		setPackerList(value);
		return this;
	}

	@Override
	public UnixFile withPeakEntropy(DoubleObjectPropertyType value) {
		setPeakEntropy(value);
		return this;
	}

	@Override
	public UnixFile withSymLinks(SymLinksListType value) {
		setSymLinks(value);
		return this;
	}

	@Override
	public UnixFile withByteRuns(ByteRunsType value) {
		setByteRuns(value);
		return this;
	}

	@Override
	public UnixFile withExtractedFeatures(ExtractedFeaturesType value) {
		setExtractedFeatures(value);
		return this;
	}

	@Override
	public UnixFile withEncryptionAlgorithm(CipherType value) {
		setEncryptionAlgorithm(value);
		return this;
	}

	@Override
	public UnixFile withDecryptionKey(StringObjectPropertyType value) {
		setDecryptionKey(value);
		return this;
	}

	@Override
	public UnixFile withCompressionMethod(StringObjectPropertyType value) {
		setCompressionMethod(value);
		return this;
	}

	@Override
	public UnixFile withCompressionVersion(StringObjectPropertyType value) {
		setCompressionVersion(value);
		return this;
	}

	@Override
	public UnixFile withCompressionComment(StringObjectPropertyType value) {
		setCompressionComment(value);
		return this;
	}

	@Override
	public UnixFile withIsPacked(Boolean value) {
		setIsPacked(value);
		return this;
	}

	@Override
	public UnixFile withIsMasqueraded(Boolean value) {
		setIsMasqueraded(value);
		return this;
	}

	@Override
	public UnixFile withCustomProperties(CustomPropertiesType value) {
		setCustomProperties(value);
		return this;
	}

	@Override
	public UnixFile 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);
		{
			StringObjectPropertyType theGroupOwner;
			theGroupOwner = this.getGroupOwner();
			strategy.appendField(locator, this, "groupOwner", buffer,
					theGroupOwner);
		}
		{
			UnsignedLongObjectPropertyType theINode;
			theINode = this.getINode();
			strategy.appendField(locator, this, "iNode", buffer, theINode);
		}
		{
			UnixFileType theType;
			theType = this.getType();
			strategy.appendField(locator, this, "type", buffer, theType);
		}
		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, UnixFile.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 UnixFile instance for XML String
	 * 
	 * @param text
	 *            XML String for the document
	 * @return The UnixFile instance for the passed XML String
	 */
	public static UnixFile fromXMLString(String text) {
		JAXBContext jaxbContext;
		try {
			jaxbContext = JAXBContext.newInstance(UnixFile.class.getPackage()
					.getName());
			Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();

			unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
			unmarshaller.setEventHandler(new ValidationEventHandler());
			StreamSource streamSource = new StreamSource(new StringReader(text));
			return (UnixFile) unmarshaller.unmarshal(streamSource);
		} catch (JAXBException e) {
			throw new RuntimeException(e);
		}
	}

	/**
	 * Validates the XML representation of this UnixFile 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());
	}

}