Internal Console API

InternalAcmeService

Other API in Package

Console

Console System

Console Webservice

List of Classes

InternalConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

InternalAcmeService

InternalApiMonitor

InternalAuthManager

InternalCloud

InternalCloudDomain

InternalCloudSubscriptionManager

InternalCloudSubscriptionService

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmail

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKey

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

InternalUser

InternalWebAlias

InternalZone

InternalZoneManager

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

Method Summary
  agreeToTerms(String contactEmail)

Marks the terms agreed to by the indicated contact email.

  configure()

Executes the next configuration step for this Acme setting. See c.getError().

  dnsReady()

Indicates DNS changes have been made and we can trigger validation

  forceDelete()

Deletes this service. All related artifacts must be manually deleted.

File getCertificate()

Returns the certificate.

Data getDNSRecord()

Returns information on the DNS TXT record to be created to prove domain ownership.

String getDomain()

Returns the domain of the service.

String getEmail()

Returns the contact email of the service.

String getJobId()

Returns the job ID.

String getOrderStatus()

Returns the order status of the service.

Date getRenewalDate()

Returns the certificate renewal date.

String getStatus()

Returns the status of the service.

String getTarget()

Returns the target- production or stage.

String getTermsUrl()

Returns the terms URL.

boolean isIncludeRoot()

Returns true if this record is configured to include the root domain.

boolean isWildCard()

Returns true if this record is a wildcard.

boolean publish()

Publishes the certificate to the load balancer for this cloud, returning true on success.

boolean remove()

Deletes this service. It must be revoked first. Returns true on success.

  renew()

Forces a renewal of the certificate which basically clears the order and starts over. Wildcard certs will require a manual DNS update.

boolean restart()

Restarts the load balancer for this cloud, returning true on success. This should be called in a background process, off hours.

boolean revoke()

Revokes the certificate.

  setJobId(String jobId)

Sets the job ID.

String toString()

Returns a description of this object

Method Detail


agreeToTerms(String contactEmail)

Marks the terms agreed to by the indicated contact email.

Parameters:

  • String   contactEmail Required parameter.

Since: 08-30-2021

top

configure()

Executes the next configuration step for this Acme setting. See c.getError().

Since: 08-30-2021

top

dnsReady()

Indicates DNS changes have been made and we can trigger validation

Since: 01-17-2022

top

forceDelete()

Deletes this service. All related artifacts must be manually deleted.

Since: 12-13-2021

top

File getCertificate()

Returns the certificate.

Returns:  File

Since: 09-11-2023

top

Data getDNSRecord()

Returns information on the DNS TXT record to be created to prove domain ownership.

Returns:  Data

Since: 08-30-2021

top

String getDomain()

Returns the domain of the service.

Returns:  String

Since: 08-30-2021

top

String getEmail()

Returns the contact email of the service.

Returns:  String

Since: 08-30-2021

top

String getJobId()

Returns the job ID.

Returns:  String

Since: 08-30-2021

top

String getOrderStatus()

Returns the order status of the service.

Returns:  String

Since: 08-30-2021

top

Date getRenewalDate()

Returns the certificate renewal date.

Returns:  Date

Since: 08-30-2021

top

String getStatus()

Returns the status of the service.

Returns:  String

Since: 08-30-2021

top

String getTarget()

Returns the target- production or stage.

Returns:  String

Since: 08-30-2021

top

String getTermsUrl()

Returns the terms URL.

Returns:  String

Since: 08-30-2021

top

boolean isIncludeRoot()

Returns true if this record is configured to include the root domain.

Returns:  boolean

Since: 01-04-2022

top

boolean isWildCard()

Returns true if this record is a wildcard.

Returns:  boolean

Since: 01-04-2022

top

boolean publish()

Publishes the certificate to the load balancer for this cloud, returning true on success.

Returns:  boolean

Since: 08-30-2021

top

boolean remove()

Deletes this service. It must be revoked first. Returns true on success.

Returns:  boolean

Since: 08-30-2021

top

renew()

Forces a renewal of the certificate which basically clears the order and starts over. Wildcard certs will require a manual DNS update.

Since: 08-30-2021

top

boolean restart()

Restarts the load balancer for this cloud, returning true on success. This should be called in a background process, off hours.

Returns:  boolean

Since: 01-18-2022

top

boolean revoke()

Revokes the certificate.

Returns:  boolean

Since: 08-30-2021

top

setJobId(String jobId)

Sets the job ID.

Parameters:

  • String   jobId Maximum allowed size of parameter: 30

Since: 08-30-2021

top

String toString()

Returns a description of this object

Returns:  String

Since: 08-30-2021

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 22, 2024 11:54 AM