InternalDomainManager

Other API in Package

Console Webservice

List of Classes

InternalConsoleController

AnalyticDataViewFilter

ChartSharedSettings

ConsoleResponse

DataViewBuilder

DataViewCriteria

DisplaySettings

DownloadResponse

InternalAcmeService

InternalApiMonitor

InternalAuthManager

InternalCloudDomain

InternalCloudSubscriptionManager

InternalCloudSubscriptionService

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalPalStore

InternalPalStoreInfo

InternalPalStoreInvite

InternalPalStoreItem

InternalProfile

InternalProfileManager

InternalPseudoKey

InternalRequest

InternalResponse

InternalSecuritySettings

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalSupportIncident

InternalSupportProfile

InternalSystemInformation

InternalSystemLog

InternalSystemManager

InternalTunnelManager

InternalWebAlias

InternalZoneManager

PacketDataRecord

PalActivationKeyInfo

ProfilePalManager

ProfileTxManager

ScatterPlotChart

ServiceResponse

ShellPalManager

SmartDocManager

StorageProvider

StorageProviderDataList

SystemDataViewFilter

TransactionPacket

TransactionUtil

WorkflowResponse

This class also used in (click to expand):

Method Summary
boolean	addDomain(String domainName) Creates a new domain. domainName must be valid according to the RFC specification and the TLD must be registered on this cloud.
boolean	addGlobalDomain(String domainName) Creates a new domain without checking for exclusivity. The cloud must enable multiple enterprises to register the same domain.
InternalWebAlias	createWebAlias(String aliasCname, String aliasDomain, String host) Creates an alias for the specified host.
boolean	deleteDomain(String id) Deletes the specified domain.
	deleteWebAlias(String id) Deletes the alias with the given id.
SystemDataView	getDomains() Returns a list of domains for this enterprise.
InternalWebAlias	getWebAlias(String id) Returns the alias with the given id.
SystemDataView	getWebAliases() Returns a list of web aliases for this enterprise.
SystemDataView	getWebPals() Returns a list of deployed web pals for this enterprise.
boolean	isDomainUnique(String domainName) Returns true if the domain is unique.
boolean	isGlobalEnabled() Returns true if this cloud permits global domains.
boolean	setDomainActive(String id, boolean active) Sets the active flag for the specified domain.
String	toString() Returns a description of this object.

Method Detail

boolean addDomain(String domainName)

Creates a new domain. domainName must be valid according to the RFC specification and the TLD must be registered on this cloud.

Parameters:

String domainName - domain name. Required parameter. Maximum allowed size of parameter: 255

Returns: boolean

Since: 09-22-2015

top

boolean addGlobalDomain(String domainName)

Creates a new domain without checking for exclusivity. The cloud must enable multiple enterprises to register the same domain.

Parameters:

String domainName - domain name. Required parameter. Maximum allowed size of parameter: 255

Returns: boolean

Since: 01-27-2021

top

InternalWebAlias createWebAlias(String aliasCname, String aliasDomain, String host)

Creates an alias for the specified host.

Parameters:

String aliasCname - aliasCname, for example * or cname or blank for root. Maximum allowed size of parameter: 255
String aliasDomain - aliasDomain, for example mysite.com. Required parameter. Maximum allowed size of parameter: 255
String host - host of the alias, for example www.actualsite.com. Required parameter. Maximum allowed size of parameter: 255

Returns: InternalWebAlias

Since: 03-02-2010

top

boolean deleteDomain(String id)

Deletes the specified domain.

Parameters:

String id Required parameter.

Returns: boolean

Since: 04-05-2010

top

deleteWebAlias(String id)

Deletes the alias with the given id.

Parameters:

String id Required parameter.

Since: 03-02-2010

top

SystemDataView getDomains()

Returns a list of domains for this enterprise.

Returns: SystemDataView

DataList Name: Domains
Tag Support: No

DataList Keys/Column Name	Column Type	Read Only
id	String
domainName	String
active	Boolean

Since: 03-02-2010

top

InternalWebAlias getWebAlias(String id)

Returns the alias with the given id.

Parameters:

String id Required parameter.

Returns: InternalWebAlias

Since: 03-02-2010

top

SystemDataView getWebAliases()

Returns a list of web aliases for this enterprise.

Returns: SystemDataView

DataList Name: WebAliases
Tag Support: No

DataList Keys/Column Name	Column Type	Read Only
id	String
alias	String
host	String
redirect	Boolean

Since: 03-02-2010

top

SystemDataView getWebPals()

Returns a list of deployed web pals for this enterprise.

Returns: SystemDataView

DataList Name: WebPals
Tag Support: No

DataList Keys/Column Name	Column Type	Read Only
palId	String
name	String
host	String
modifiedDate	Date
firstName	String
lastName	String
email	String

Since: 03-02-2010

top

boolean isDomainUnique(String domainName)

Returns true if the domain is unique.

Parameters:

String domainName - domain name. Required parameter. Maximum allowed size of parameter: 255

Returns: boolean

Since: 03-02-2010

top

boolean isGlobalEnabled()

Returns true if this cloud permits global domains.

Returns: boolean

Since: 01-27-2021

top

boolean setDomainActive(String id, boolean active)

Sets the active flag for the specified domain.

Parameters:

String id Required parameter.
boolean active

Returns: boolean

Since: 04-05-2010

top

String toString()

Returns a description of this object.

Returns: String

Since: 03-02-2010

top

Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved.

API Date: May 01, 2024 05:15 AM