org.mitre.cybox.objects.UnixUserAccount 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 java.util.Collection;
import java.util.List;
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.DateTimeObjectPropertyType;
import org.mitre.cybox.common_2.DurationObjectPropertyType;
import org.mitre.cybox.common_2.StringObjectPropertyType;
import org.mitre.cybox.common_2.UnsignedIntegerObjectPropertyType;
import org.mitre.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;

/**
 * The UnixUserAccountType type is intended to characterize Unix user accounts.
 * 
 * Java class for UnixUserAccountObjectType complex type.
 * 
 * 
The following schema fragment specifies the expected content contained within this class.
 * 
 * 
 * <complexType name="UnixUserAccountObjectType">
 *   <complexContent>
 *     <extension base="{http://cybox.mitre.org/objects#UserAccountObject-2}UserAccountObjectType">
 *       <sequence>
 *         <element name="Group_ID" type="{http://cybox.mitre.org/common-2}UnsignedIntegerObjectPropertyType" minOccurs="0"/>
 *         <element name="User_ID" type="{http://cybox.mitre.org/common-2}UnsignedIntegerObjectPropertyType" minOccurs="0"/>
 *         <element name="Login_Shell" type="{http://cybox.mitre.org/common-2}StringObjectPropertyType" minOccurs="0"/>
 *       </sequence>
 *     </extension>
 *   </complexContent>
 * </complexType>
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "UnixUserAccountObjectType", namespace = "http://cybox.mitre.org/objects#UnixUserAccountObject-2", propOrder = {
		"groupID", "userID", "loginShell" })
@XmlRootElement(name = "Unix_User_Account", namespace = "http://cybox.mitre.org/objects#UnixUserAccountObject-2")
public class UnixUserAccount extends UserAccountObjectType implements Equals,
		HashCode, ToString {

	@XmlElement(name = "Group_ID")
	protected UnsignedIntegerObjectPropertyType groupID;
	@XmlElement(name = "User_ID")
	protected UnsignedIntegerObjectPropertyType userID;
	@XmlElement(name = "Login_Shell")
	protected StringObjectPropertyType loginShell;

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

	/**
	 * Fully-initialising value constructor
	 * 
	 */
	public UnixUserAccount(final CustomPropertiesType customProperties,
			final QName objectReference,
			final StringObjectPropertyType description,
			final StringObjectPropertyType domain,
			final List authentications,
			final DateTimeObjectPropertyType creationDate,
			final DateTimeObjectPropertyType modifiedDate,
			final DateTimeObjectPropertyType lastAccessedTime,
			final Boolean disabled, final Boolean lockedOut,
			final StringObjectPropertyType fullName,
			final GroupListType groupList,
			final StringObjectPropertyType homeDirectory,
			final DateTimeObjectPropertyType lastLogin,
			final PrivilegeListType privilegeList,
			final StringObjectPropertyType scriptPath,
			final StringObjectPropertyType username,
			final DurationObjectPropertyType userPasswordAge,
			final Boolean passwordRequired,
			final UnsignedIntegerObjectPropertyType groupID,
			final UnsignedIntegerObjectPropertyType userID,
			final StringObjectPropertyType loginShell) {
		super(customProperties, objectReference, description, domain,
				authentications, creationDate, modifiedDate, lastAccessedTime,
				disabled, lockedOut, fullName, groupList, homeDirectory,
				lastLogin, privilegeList, scriptPath, username,
				userPasswordAge, passwordRequired);
		this.groupID = groupID;
		this.userID = userID;
		this.loginShell = loginShell;
	}

	/**
	 * Gets the value of the groupID property.
	 * 
	 * @return
	 *     possible object is
	 *     {@link UnsignedIntegerObjectPropertyType }
	 *     
	 */
	public UnsignedIntegerObjectPropertyType getGroupID() {
		return groupID;
	}

	/**
	 * Sets the value of the groupID property.
	 * 
	 * @param value
	 *     allowed object is
	 *     {@link UnsignedIntegerObjectPropertyType }
	 *     
	 */
	public void setGroupID(UnsignedIntegerObjectPropertyType value) {
		this.groupID = value;
	}

	/**
	 * Gets the value of the userID property.
	 * 
	 * @return
	 *     possible object is
	 *     {@link UnsignedIntegerObjectPropertyType }
	 *     
	 */
	public UnsignedIntegerObjectPropertyType getUserID() {
		return userID;
	}

	/**
	 * Sets the value of the userID property.
	 * 
	 * @param value
	 *     allowed object is
	 *     {@link UnsignedIntegerObjectPropertyType }
	 *     
	 */
	public void setUserID(UnsignedIntegerObjectPropertyType value) {
		this.userID = value;
	}

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

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

	public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
			Object object, EqualsStrategy strategy) {
		if (!(object instanceof UnixUserAccount)) {
			return false;
		}
		if (this == object) {
			return true;
		}
		if (!super.equals(thisLocator, thatLocator, object, strategy)) {
			return false;
		}
		final UnixUserAccount that = ((UnixUserAccount) object);
		{
			UnsignedIntegerObjectPropertyType lhsGroupID;
			lhsGroupID = this.getGroupID();
			UnsignedIntegerObjectPropertyType rhsGroupID;
			rhsGroupID = that.getGroupID();
			if (!strategy.equals(
					LocatorUtils.property(thisLocator, "groupID", lhsGroupID),
					LocatorUtils.property(thatLocator, "groupID", rhsGroupID),
					lhsGroupID, rhsGroupID)) {
				return false;
			}
		}
		{
			UnsignedIntegerObjectPropertyType lhsUserID;
			lhsUserID = this.getUserID();
			UnsignedIntegerObjectPropertyType rhsUserID;
			rhsUserID = that.getUserID();
			if (!strategy.equals(
					LocatorUtils.property(thisLocator, "userID", lhsUserID),
					LocatorUtils.property(thatLocator, "userID", rhsUserID),
					lhsUserID, rhsUserID)) {
				return false;
			}
		}
		{
			StringObjectPropertyType lhsLoginShell;
			lhsLoginShell = this.getLoginShell();
			StringObjectPropertyType rhsLoginShell;
			rhsLoginShell = that.getLoginShell();
			if (!strategy.equals(LocatorUtils.property(thisLocator,
					"loginShell", lhsLoginShell), LocatorUtils.property(
					thatLocator, "loginShell", rhsLoginShell), lhsLoginShell,
					rhsLoginShell)) {
				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);
		{
			UnsignedIntegerObjectPropertyType theGroupID;
			theGroupID = this.getGroupID();
			currentHashCode = strategy.hashCode(
					LocatorUtils.property(locator, "groupID", theGroupID),
					currentHashCode, theGroupID);
		}
		{
			UnsignedIntegerObjectPropertyType theUserID;
			theUserID = this.getUserID();
			currentHashCode = strategy.hashCode(
					LocatorUtils.property(locator, "userID", theUserID),
					currentHashCode, theUserID);
		}
		{
			StringObjectPropertyType theLoginShell;
			theLoginShell = this.getLoginShell();
			currentHashCode = strategy
					.hashCode(LocatorUtils.property(locator, "loginShell",
							theLoginShell), currentHashCode, theLoginShell);
		}
		return currentHashCode;
	}

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

	public UnixUserAccount withGroupID(UnsignedIntegerObjectPropertyType value) {
		setGroupID(value);
		return this;
	}

	public UnixUserAccount withUserID(UnsignedIntegerObjectPropertyType value) {
		setUserID(value);
		return this;
	}

	public UnixUserAccount withLoginShell(StringObjectPropertyType value) {
		setLoginShell(value);
		return this;
	}

	@Override
	public UnixUserAccount withFullName(StringObjectPropertyType value) {
		setFullName(value);
		return this;
	}

	@Override
	public UnixUserAccount withGroupList(GroupListType value) {
		setGroupList(value);
		return this;
	}

	@Override
	public UnixUserAccount withHomeDirectory(StringObjectPropertyType value) {
		setHomeDirectory(value);
		return this;
	}

	@Override
	public UnixUserAccount withLastLogin(DateTimeObjectPropertyType value) {
		setLastLogin(value);
		return this;
	}

	@Override
	public UnixUserAccount withPrivilegeList(PrivilegeListType value) {
		setPrivilegeList(value);
		return this;
	}

	@Override
	public UnixUserAccount withScriptPath(StringObjectPropertyType value) {
		setScriptPath(value);
		return this;
	}

	@Override
	public UnixUserAccount withUsername(StringObjectPropertyType value) {
		setUsername(value);
		return this;
	}

	@Override
	public UnixUserAccount withUserPasswordAge(DurationObjectPropertyType value) {
		setUserPasswordAge(value);
		return this;
	}

	@Override
	public UnixUserAccount withPasswordRequired(Boolean value) {
		setPasswordRequired(value);
		return this;
	}

	@Override
	public UnixUserAccount withDescription(StringObjectPropertyType value) {
		setDescription(value);
		return this;
	}

	@Override
	public UnixUserAccount withDomain(StringObjectPropertyType value) {
		setDomain(value);
		return this;
	}

	@Override
	public UnixUserAccount withAuthentications(AuthenticationType... values) {
		if (values != null) {
			for (AuthenticationType value : values) {
				getAuthentications().add(value);
			}
		}
		return this;
	}

	@Override
	public UnixUserAccount withAuthentications(
			Collection values) {
		if (values != null) {
			getAuthentications().addAll(values);
		}
		return this;
	}

	@Override
	public UnixUserAccount withCreationDate(DateTimeObjectPropertyType value) {
		setCreationDate(value);
		return this;
	}

	@Override
	public UnixUserAccount withModifiedDate(DateTimeObjectPropertyType value) {
		setModifiedDate(value);
		return this;
	}

	@Override
	public UnixUserAccount withLastAccessedTime(DateTimeObjectPropertyType value) {
		setLastAccessedTime(value);
		return this;
	}

	@Override
	public UnixUserAccount withDisabled(Boolean value) {
		setDisabled(value);
		return this;
	}

	@Override
	public UnixUserAccount withLockedOut(Boolean value) {
		setLockedOut(value);
		return this;
	}

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

	@Override
	public UnixUserAccount 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);
		{
			UnsignedIntegerObjectPropertyType theGroupID;
			theGroupID = this.getGroupID();
			strategy.appendField(locator, this, "groupID", buffer, theGroupID);
		}
		{
			UnsignedIntegerObjectPropertyType theUserID;
			theUserID = this.getUserID();
			strategy.appendField(locator, this, "userID", buffer, theUserID);
		}
		{
			StringObjectPropertyType theLoginShell;
			theLoginShell = this.getLoginShell();
			strategy.appendField(locator, this, "loginShell", buffer,
					theLoginShell);
		}
		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, UnixUserAccount.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 UnixUserAccount instance for XML String
	 * 
	 * @param text
	 *            XML String for the document
	 * @return The UnixUserAccount instance for the passed XML String
	 */
	public static UnixUserAccount fromXMLString(String text) {
		JAXBContext jaxbContext;
		try {
			jaxbContext = JAXBContext.newInstance(UnixUserAccount.class
					.getPackage().getName());
			Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();

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

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

}