Package com.morpheusdata.model
Class NetworkDomain
- java.lang.Object
-
- com.morpheusdata.model.MorpheusModel
-
- com.morpheusdata.model.projection.NetworkDomainIdentityProjection
-
- com.morpheusdata.model.NetworkDomain
-
public class NetworkDomain extends NetworkDomainIdentityProjection
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 Description protected Account
account
protected java.lang.String
configuration
protected java.lang.String
description
protected java.lang.String
displayName
protected java.lang.Boolean
dnssec
protected java.lang.String
domainPassword
protected java.lang.String
domainSerial
protected java.lang.String
domainUsername
java.lang.String
fqdn
protected java.lang.String
guestPassword
protected java.lang.String
guestUsername
protected java.lang.String
internalId
protected java.lang.String
name
protected java.lang.String
ouPath
protected Account
owner
protected java.lang.Boolean
publicZone
protected java.lang.Long
refId
protected java.lang.String
refSource
protected java.lang.String
refType
protected java.lang.String
reverseExternalId
protected java.lang.String
reverseFqdn
protected java.lang.String
reverseName
protected java.lang.String
zoneType
-
Fields inherited from class com.morpheusdata.model.projection.NetworkDomainIdentityProjection
externalId
-
Fields inherited from class com.morpheusdata.model.MorpheusModel
config, id
-
-
Constructor Summary
Constructors Constructor Description NetworkDomain()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Account
getAccount()
java.lang.String
getConfiguration()
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
getDomainPassword()
java.lang.String
getDomainSerial()
java.lang.String
getDomainUsername()
java.lang.String
getGuestPassword()
java.lang.String
getGuestUsername()
java.lang.String
getInternalId()
java.lang.String
getOuPath()
Gets the OUPath string for joining an OU in Active Directory.Account
getOwner()
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 thegetRefType()
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
getReverseExternalId()
java.lang.String
getReverseFqdn()
java.lang.String
getReverseName()
java.lang.String
getZoneType()
Gets the string representation of the cloud type this Domain record correlates to.void
setAccount(Account account)
void
setConfiguration(java.lang.String configuration)
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
setDomainPassword(java.lang.String domainPassword)
void
setDomainSerial(java.lang.String domainSerial)
void
setDomainUsername(java.lang.String domainUsername)
void
setGuestPassword(java.lang.String guestPassword)
void
setGuestUsername(java.lang.String guestUsername)
void
setInternalId(java.lang.String internalId)
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
setOwner(Account owner)
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 thegetRefType()
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
setReverseExternalId(java.lang.String reverseExternalId)
void
setReverseFqdn(java.lang.String reverseFqdn)
void
setReverseName(java.lang.String reverseName)
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.projection.NetworkDomainIdentityProjection
getExternalId, getId, getName, setExternalId, setId, setName
-
Methods inherited from class com.morpheusdata.model.MorpheusModel
getConfig, getConfigMap, getConfigProperty, getDirtyProperties, getDirtyPropertyValues, getProperties, isDirty, markClean, markDirty, markDirty, setConfig, setConfigMap, setConfigProperty
-
-
-
-
Field Detail
-
account
protected Account account
-
owner
protected Account owner
-
displayName
protected java.lang.String displayName
-
name
protected java.lang.String name
-
description
protected java.lang.String description
-
publicZone
protected java.lang.Boolean publicZone
-
refType
protected java.lang.String refType
-
refId
protected java.lang.Long refId
-
refSource
protected java.lang.String refSource
-
ouPath
protected java.lang.String ouPath
-
zoneType
protected java.lang.String zoneType
-
dnssec
protected java.lang.Boolean dnssec
-
fqdn
public java.lang.String fqdn
-
domainSerial
protected java.lang.String domainSerial
-
reverseName
protected java.lang.String reverseName
-
reverseFqdn
protected java.lang.String reverseFqdn
-
reverseExternalId
protected java.lang.String reverseExternalId
-
configuration
protected java.lang.String configuration
-
internalId
protected java.lang.String internalId
-
domainUsername
protected java.lang.String domainUsername
-
domainPassword
protected java.lang.String domainPassword
-
guestUsername
protected java.lang.String guestUsername
-
guestPassword
protected java.lang.String guestPassword
-
-
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.
-
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 thegetRefType()
method. In most cases this is the id property correlating to theAccountIntegration
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 thegetRefType()
method. In most cases this is the id property correlating to theAccountIntegration
the Domain record is synced from.- Parameters:
refId
- the database unique identifier corresponding to the related Model as defined bygetRefType()
.
-
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 anIPAMProvider
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.
-
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 aDNSProvider
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.
-
getAccount
public Account getAccount()
-
setAccount
public void setAccount(Account account)
-
getOwner
public Account getOwner()
-
setOwner
public void setOwner(Account owner)
-
getDomainSerial
public java.lang.String getDomainSerial()
-
setDomainSerial
public void setDomainSerial(java.lang.String domainSerial)
-
getReverseName
public java.lang.String getReverseName()
-
setReverseName
public void setReverseName(java.lang.String reverseName)
-
getReverseFqdn
public java.lang.String getReverseFqdn()
-
setReverseFqdn
public void setReverseFqdn(java.lang.String reverseFqdn)
-
getReverseExternalId
public java.lang.String getReverseExternalId()
-
setReverseExternalId
public void setReverseExternalId(java.lang.String reverseExternalId)
-
getConfiguration
public java.lang.String getConfiguration()
-
setConfiguration
public void setConfiguration(java.lang.String configuration)
-
getDomainUsername
public java.lang.String getDomainUsername()
-
setDomainUsername
public void setDomainUsername(java.lang.String domainUsername)
-
getDomainPassword
public java.lang.String getDomainPassword()
-
setDomainPassword
public void setDomainPassword(java.lang.String domainPassword)
-
getGuestUsername
public java.lang.String getGuestUsername()
-
setGuestUsername
public void setGuestUsername(java.lang.String guestUsername)
-
getGuestPassword
public java.lang.String getGuestPassword()
-
setGuestPassword
public void setGuestPassword(java.lang.String guestPassword)
-
getInternalId
public java.lang.String getInternalId()
-
setInternalId
public void setInternalId(java.lang.String internalId)
-
-