com.morpheusdata.model.NetworkDomain Maven / Gradle / Ivy

Go to download
/*
 *  Copyright 2024 Morpheus Data, LLC.
 *
 * Licensed under the PLUGIN CORE SOURCE LICENSE (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://raw.githubusercontent.com/gomorpheus/morpheus-plugin-core/v1.0.x/LICENSE
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.morpheusdata.model;

import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.morpheusdata.core.providers.DNSProvider;
import com.morpheusdata.core.providers.IPAMProvider;
import com.morpheusdata.model.projection.NetworkDomainIdentityProjection;
import com.morpheusdata.model.serializers.ModelAsIdOnlySerializer;

/**
 * This is a Model Representation of a Network Domain. It contains information related to any DNS Cloud that may be synced
 * via a DNS and/or IPAM provider.
 *
 * @see IPAMProvider
 * @see DNSProvider
 *
 * @author David Estes
 */
public class NetworkDomain extends NetworkDomainIdentityProjection {

	@JsonSerialize(using= ModelAsIdOnlySerializer.class)
	protected Account account;
	@JsonSerialize(using= ModelAsIdOnlySerializer.class)
	protected Account owner;

	/**
	 * The Display Name of the current Network Domain. This Display Name is typically not changed directly by an integration
	 * but can be if necessary. Primarily it is a user adjustable setting performed in the UI.
	 */
	protected String displayName;
	/**
	 * The name of the current Network Domain. This is often synced in and represents the actual zone name
	 */
	protected String name;
	protected String description;
	protected Boolean publicZone = false;
	protected String refType;
	protected Long refId;
	protected String refSource = "integration";
	protected String ouPath;
	String dcServer;
	protected String zoneType;
	protected Boolean dnssec;
	public String fqdn;
	protected String domainSerial;
	protected Boolean active = true;
	//reverse zone
	protected String reverseName;
	protected String reverseFqdn;
	protected String reverseExternalId;
	protected String regionCode;
	//tasks
	//bluecat field for configuration
	protected String configuration;

	//referenceIds
	protected String internalId;

	//windows domain join stuff
	protected String domainUsername;
	protected String domainPassword;
	protected String guestUsername;
	protected String guestPassword;

	/**
	 * Gets the display name of the current Network Domain. Domains can have a display name for situations where the same
	 * Domain record exists multiple times but may target different OU Paths for example. This provides a way for the user
	 * to override a Domain Name and change its display for consumption.
	 * @return display name
	 */
	public String getDisplayName() {
		return displayName;
	}

	/**
	 * Sets the Display Name of the current Network Domain. This Display Name is typically not changed directly by an integration
	 * but can be if necessary. Primarily it is a user adjustable setting performed in the UI.
	 * @param displayName the Human readable display name to be presented to the user during provisioning. Should be left blank when syncing.
	 */
	public void setDisplayName(String displayName) {
		this.displayName = displayName;
		markDirty("displayName",displayName);
	}

	/**
	 * Gets the human readable description representation of the Domain Record in question. This may get synced in from a provider
	 * or often can be set directly by the user.
	 * @return a descriptive block of text providing the user with more information about the Domain.
	 */
	public String getDescription() {
		return description;
	}

	/**
	 * Sets the human-readable description text for a DNS Cloud. This can be useful for providing more details to the user as to
	 * what may belong in this cloud or where it may be geographically associated to.
	 * @param description a descriptive block of text providing the user with more information about the Domain.
	 */
	public void setDescription(String description) {
		this.description = description;
		markDirty("description",description);
	}


	/**
	 * A flag to represent whether the authoritative cloud in question is a public or internal dns cloud.
	 * @return Boolean state of public cloud flag.
	 */
	public Boolean getPublicZone() {
		return publicZone;
	}

	/**
	 * Sets the Public Cloud qualifier flag used for defining if the current Cloud is a public or internal DNS Cloud.
	 * @param publicZone cloud
	 */
	public void setPublicZone(Boolean publicZone) {
		this.publicZone = publicZone;
	}

	/**
	 * A String form of the Model class name that this Domain Record is related to. Typically via most Integrations the value
	 * of this field should be 'AccountIntegration', however some scenarios exist where this may get synced or created via an
	 * alternative means (perhaps from a CloudProvider).
	 * @return String representation of Model that this record was associated with externally (typically 'AccountIntegration')
	 */
	public String getRefType() {
		return refType;
	}

	/**
	 * Set the String form of the Model class name that this Domain Record is related to. Typically, via most Integrations the value
	 * of this field should be 'AccountIntegration', however some scenarios exist where this may get synced or created via an
	 * alternative means (perhaps from a CloudProvider). The refId is also required when using this field.
	 * @param refType type
	 */
	public void setRefType(String refType) {
		this.refType = refType;
	}

	/**
	 * Gets the Reference Id correlating to the Model object as defined by the {@link #getRefType} method. In most cases
	 * this is the id property correlating to the {@link AccountIntegration} the Domain record is synced from.
	 * @return the database unique identifier corresponding to the related Model as defined by {@link #getRefType}.
	 */
	public Long getRefId() {
		return refId;
	}

	/**
	 * Sets the Reference Id correlating to the Model object as defined by the {@link #getRefType} method. In most cases
	 * this is the id property correlating to the {@link AccountIntegration} the Domain record is synced from.
	 * @param refId the database unique identifier corresponding to the related Model as defined by {@link #getRefType}.
	 */
	public void setRefId(Long refId) {
		this.refId = refId;
	}

	/**
	 * Represents the source of the Domain record. How it was created. Was it user created and later associated with the integration
	 * or was it created via a sync. This is useful during sync to determine if a record should be flagged for removal or not.
	 * @return reference source String (should be of value "integration" or value "user") to determine where it came from.
	 */
	public String getRefSource() {
		return refSource;
	}

	/**
	 * Sets the reference source property to mark where the Domain Record was created from. When creating during a sync operation
	 * via an {@link IPAMProvider} it is best to set this property to "integration".
	 * @param refSource reference source String (should be of value "integration" or value "user") to determine where it came from.
	 */
	public void setRefSource(String refSource) {
		this.refSource = refSource;
	}

	/**
	 * Gets the OUPath string for joining an OU in Active Directory. An OU Path is a path typically correlating to an organizational unit within Active Directory (Microsoft DNS Zones).
	 * In most cases this is set by the user unless the external DNS Provider supports synchronizing of OU Information.
	 * @return The String AD representation of an OU when joining a Domain.
	 */
	public String getOuPath() {
		return ouPath;
	}

	/**
	 * Sets the OUPath (Organizational Unit) of a Cloud that may be used for joining an Active Directory Windows Domain Controller. It is possible
	 * for multiple Cloud Records to exist with the same FQDN, but with a different OU Path qualifier.
	 * @param ouPath The String AD representation of an OU when joining a Domain.
	 */
	public void setOuPath(String ouPath) {
		this.ouPath = ouPath;
	}

	/**
	 * Gets the string representation of the cloud type this Domain record correlates to. An example might be an "authoritative" cloud or a "forward" cloud.
	 * @return A string representation of the type of cloud this domain record correlates to.
	 */
	public String getZoneType() {
		return zoneType;
	}

	/**
	 * Typically set during sync, allows the sync services to represent the type of cloud record being synced. For example there are multiple
	 * types of zones when it comes to DNS such as (authoritative, forward, or even reverse).
	 * @param zoneType A string representation of the type of cloud this domain record correlates to.
	 */
	public void setZoneType(String zoneType) {
		this.zoneType = zoneType;
	}

	/**
	 * Gets the flag representing whether or not the Provider of this Domain Record provides DNSSec features. For more information
	 * please refer to the documentation provided by icann.org regarding DNSSec and what it stands for.
	 * @return Boolean representation indicating if the referred to cloud is providing DNSSec capabilities.
	 */
	public Boolean getDnssec() {
		return dnssec;
	}

	/**
	 * Sets the DNSSec flag. this is typically done via a {@link DNSProvider} sync operation. For more information
	 * please refer to the documentation provided by icann.org regarding DNSSec and what it stands for.
	 * @param dnssec Boolean representation indicating if the referred to cloud is providing DNSSec capabilities.
	 */
	public void setDnssec(Boolean dnssec) {
		this.dnssec = dnssec;
	}

	public Account getAccount() {
		return account;
	}

	public void setAccount(Account account) {
		this.account = account;
	}

	public Account getOwner() {
		return owner;
	}

	public void setOwner(Account owner) {
		this.owner = owner;
	}

	public String getDomainSerial() {
		return domainSerial;
	}

	public void setDomainSerial(String domainSerial) {
		this.domainSerial = domainSerial;
	}

	public String getReverseName() {
		return reverseName;
	}

	public void setReverseName(String reverseName) {
		this.reverseName = reverseName;
	}

	public String getReverseFqdn() {
		return reverseFqdn;
	}

	public void setReverseFqdn(String reverseFqdn) {
		this.reverseFqdn = reverseFqdn;
	}

	public String getReverseExternalId() {
		return reverseExternalId;
	}

	public void setReverseExternalId(String reverseExternalId) {
		this.reverseExternalId = reverseExternalId;
	}

	public String getConfiguration() {
		return configuration;
	}

	public void setConfiguration(String configuration) {
		this.configuration = configuration;
	}

	public String getDomainUsername() {
		return domainUsername;
	}

	public void setDomainUsername(String domainUsername) {
		this.domainUsername = domainUsername;
	}

	public String getDomainPassword() {
		return domainPassword;
	}

	public void setDomainPassword(String domainPassword) {
		this.domainPassword = domainPassword;
	}

	public String getGuestUsername() {
		return guestUsername;
	}

	public void setGuestUsername(String guestUsername) {
		this.guestUsername = guestUsername;
	}

	public String getGuestPassword() {
		return guestPassword;
	}

	public void setGuestPassword(String guestPassword) {
		this.guestPassword = guestPassword;
	}

	public String getInternalId() {
		return internalId;
	}

	public void setInternalId(String internalId) {
		this.internalId = internalId;
	}

	public String getRegionCode() {
		return regionCode;
	}

	public void setRegionCode(String regionCode) {
		this.regionCode = regionCode;
	}

	@Override
	public String getName() {
		return name;
	}

	@Override
	public void setName(String name) {
		this.name = name;
		markDirty("name", name);
	}

	public String getDcServer() {
		return dcServer;
	}

	public void setDcServer(String dcServer) {
		this.dcServer = dcServer;
		markDirty("dcServer", dcServer);
	}

	public String getFqdn() {
		return fqdn;
	}

	public void setFqdn(String fqdn) {
		this.fqdn = fqdn;
		markDirty("fqdn", fqdn);
	}

	public Boolean getActive() {
		return active;
	}

	public void setActive(Boolean active) {
		this.active = active;
		markDirty("active", active);
	}
}