com.morpheusdata.model

Class NetworkDomain

java.lang.Object

com.morpheusdata.model.MorpheusModel

com.morpheusdata.model.NetworkDomain

public class NetworkDomain
extends MorpheusModel

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 Also:

IPAMProvider, DNSProvider

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	fqdn

Fields inherited from class com.morpheusdata.model.MorpheusModel

config, id

Constructor Summary

Constructors

Constructor and Description
NetworkDomain()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Gets the human readable description representation of the Domain Record in question.
java.lang.String	getDisplayName() Gets the display name of the current Network Domain.
java.lang.Boolean	getDnssec() Gets the flag representing whether or not the Provider of this Domain Record provides DNSSec features.
java.lang.String	getExternalId() Gets the external unique identifier.
java.lang.String	getName() Grabs the current Domain name.
java.lang.String	getOuPath() Gets the OUPath string for joining an OU in Active Directory.
java.lang.Boolean	getPublicZone() A flag to represent whether the authoritative cloud in question is a public or internal dns cloud.
java.lang.Long	getRefId() Gets the Reference Id correlating to the Model object as defined by the getRefType() method.
java.lang.String	getRefSource() Represents the source of the Domain record.
java.lang.String	getRefType() A String form of the Model class name that this Domain Record is related to.
java.lang.String	getZoneType() Gets the string representation of the cloud type this Domain record correlates to.
void	setDescription(java.lang.String description) Sets the human readable description text for a DNS Cloud.
void	setDisplayName(java.lang.String displayName) Sets the Display Name of the current Network Domain.
void	setDnssec(java.lang.Boolean dnssec) Sets the DNSSec flag.
void	setExternalId(java.lang.String externalId) Sets the external unique identifer as it relates to the integration provider.
void	setName(java.lang.String name) Sets the current Domain name for the Authoritative cloud this record represents.
void	setOuPath(java.lang.String ouPath) Sets the OUPath (Organizational Unit) of a Cloud that may be used for joining an Active Directory Windows Domain Controller.
void	setPublicZone(java.lang.Boolean publicZone) Sets the Public Cloud qualifier flag used for defining if the current Cloud is a public or internal DNS Cloud.
void	setRefId(java.lang.Long refId) Sets the Reference Id correlating to the Model object as defined by the getRefType() method.
void	setRefSource(java.lang.String refSource) Sets the reference source property to mark where the Domain Record was created from.
void	setRefType(java.lang.String refType) Set the String form of the Model class name that this Domain Record is related to.
void	setZoneType(java.lang.String zoneType) Typically set during sync, allows the sync services to represent the type of cloud record being synced.

Methods inherited from class com.morpheusdata.model.MorpheusModel

getConfig, getConfigMap, getConfigProperty, getDirtyProperties, getDirtyPropertyValues, getId, getProperties, markClean, markDirty, setConfig, setConfigMap, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fqdn

public java.lang.String fqdn

Constructor Detail

NetworkDomain

public NetworkDomain()

Method Detail

getDisplayName

public java.lang.String getDisplayName()

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.

Returns:

display name

setDisplayName

public void setDisplayName(java.lang.String 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.

Parameters:

displayName - the Human readable display name to be presented to the user during provisioning. Should be left blank when syncing.

getName

public java.lang.String getName()

Grabs the current Domain name. This should be the fully qualified DNS Name of the Authoritative Cloud it represents.

Returns:

name

setName

public void setName(java.lang.String name)

Sets the current Domain name for the Authoritative cloud this record represents.

Parameters:

name - The Fully Qualified domain name of the Cloud being represented.

getDescription

public java.lang.String getDescription()

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.

Returns:

a descriptive block of text providing the user with more information about the Domain.

setDescription

public void setDescription(java.lang.String 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.

Parameters:

description - a descriptive block of text providing the user with more information about the Domain.

getPublicZone

public java.lang.Boolean getPublicZone()

A flag to represent whether the authoritative cloud in question is a public or internal dns cloud.

Returns:

Boolean state of public cloud flag.

setPublicZone

public void setPublicZone(java.lang.Boolean publicZone)

Sets the Public Cloud qualifier flag used for defining if the current Cloud is a public or internal DNS Cloud.

Parameters:

publicZone - cloud

getRefType

public java.lang.String getRefType()

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).

Returns:

String representation of Model that this record was associated with externally (typically 'AccountIntegration')

setRefType

public void setRefType(java.lang.String 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.

Parameters:

refType - type

getRefId

public java.lang.Long getRefId()

Gets the Reference Id correlating to the Model object as defined by the getRefType() method. In most cases this is the id property correlating to the AccountIntegration the Domain record is synced from.

Returns:

the database unique identifier corresponding to the related Model as defined by getRefType().

setRefId

public void setRefId(java.lang.Long refId)

Sets the Reference Id correlating to the Model object as defined by the getRefType() method. In most cases this is the id property correlating to the AccountIntegration the Domain record is synced from.

Parameters:

refId - the database unique identifier corresponding to the related Model as defined by getRefType().

getRefSource

public java.lang.String getRefSource()

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.

Returns:

reference source String (should be of value "integration" or value "user") to determine where it came from.

setRefSource

public void setRefSource(java.lang.String refSource)

Sets the reference source property to mark where the Domain Record was created from. When creating during a sync operation via an IPAMProvider it is best to set this property to "integration".

Parameters:

refSource - reference source String (should be of value "integration" or value "user") to determine where it came from.

getExternalId

public java.lang.String getExternalId()

Gets the external unique identifier. The externalId is available on most sync related Models and is the unique identifier used by the external integration of the correlating object. Whenever syncing something like a Domain record, the unique identifier provided by the third party vendor should be stored here for cross referencing during sync.

Returns:

the external unique identifier representation of this cloud from the external integration.

setExternalId

public void setExternalId(java.lang.String externalId)

Sets the external unique identifer as it relates to the integration provider. Whenever syncing something like a Domain record, the unique identifier provided by the third party vendor should be stored here for cross referencing during sync.

Parameters:

externalId - the external unique identifier representation of this cloud from the external integration.

getOuPath

public java.lang.String getOuPath()

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.

Returns:

The String AD representation of an OU when joining a Domain.

setOuPath

public void setOuPath(java.lang.String 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.

Parameters:

ouPath - The String AD representation of an OU when joining a Domain.

getZoneType

public java.lang.String getZoneType()

Gets the string representation of the cloud type this Domain record correlates to. An example might be an "authoritative" cloud or a "forward" cloud.

Returns:

A string representation of the type of cloud this domain record correlates to.

setZoneType

public void setZoneType(java.lang.String 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).

Parameters:

zoneType - A string representation of the type of cloud this domain record correlates to.

getDnssec

public java.lang.Boolean getDnssec()

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.

Returns:

Boolean representation indicating if the referred to cloud is providing DNSSec capabilities.

setDnssec

public void setDnssec(java.lang.Boolean dnssec)

Sets the DNSSec flag. this is typically done via a DNSProvider sync operation. For more information please refer to the documentation provided by icann.org regarding DNSSec and what it stands for.

Parameters:

dnssec - Boolean representation indicating if the referred to cloud is providing DNSSec capabilities.