Namespace: OpenEdge.DataAdmin.Util
Class
DomainSystemExport
Parent classes:
Inherits: Progress.Lang.Object

Copyright (c) 2016 by Progress Software Corporation. All rights reserved.
File:DomainSystemExport
Purpose:Creates export files for configuring an STS/AG
Author(s):pjudge
Created:Tue Apr 12 07:38:22 EDT 2016
Notes:* Outputs are
- domains.json : domain config
- domainsks.csv : the domain name and DAC.
Only dumped if the user is a security admin
/* Published to allow customisation of whether a domain is exported, and with what data




Method Summary
Options Name Purpose
DestroyLogger () /* Closes the logger and cleans up */
Export () /* Exports domains from all known databases */
Export (character) /* Exports domain & system info for import into an STS @param character A single connected database */
ExportSingle (character, StsDomainConfig) /* Performs the export for a single given db @param character A database name to dump @param StsDomainConfig The domain dump set */
InitializeLogging (character, LogLevelEnum) /* Initialises logging at a particular level. @param character The log file into which to log @param LogLevelEnum The levle of the events to log */
InitializeLogging (character, LogLevelEnum) /* Initialises logging at a particular level. This is a public, previously-published API and we need to support a map back to the OE.Core enums @param character The log file into which to log @param OpenEdge.Core.LogLevelEnum The level of the events to log - for backwards compat */
LogMessage (character, LogLevelEnum) /* Logs a message @param character The message to log @param LogLevelEnum The level of this message */
OnValidateExportRecord (DomainSystemExportEventArgs) /* Publishes the ValidateExportRecord event to allow listeners to tweak the dump @param DomainSystemExportEventArgs The event args for this domain */
ValidateExportFolder () /* Check whether the ExportFolder is the -T folder and report if so */

Constructor Summary
Options Name Purpose
DomainSystemExport () /* Default constructor. */
DomainSystemExport (character) /* Constructor. @param character The database name from which to dump. * means all connected */
DomainSystemExport (character[]) /* Constructor. @param character[] An array of database names from which to dump. */

Event Summary
Options Name Purpose
ValidateExportRecord (Object, DomainSystemExportEventArgs) /* Published to allow customisation of whether a domain is exported, and with what data */

Property Summary
Options Name Purpose
CHARACTER DbName
CHARACTER DomainConfigFile
CHARACTER DomainKeysFile
CHARACTER ExportFolder
LOGICAL MakeDomainSSO


Method Detail
Top

PUBLIC DestroyLogger ()

/* Closes the logger and cleans up
Top

PUBLIC Export ()

/* Exports domains from all known databases
Top

PUBLIC Export (character)

/* Exports domain & system info for import into an STS
Parameters:
pcDbName CHARACTER
Top

PROTECTED ExportSingle (character, StsDomainConfig)

/* Performs the export for a single given db
Parameters:
pcDbName CHARACTER
poConfig OpenEdge.DataAdmin.Util.StsDomainConfig
Top

PUBLIC InitializeLogging (character, LogLevelEnum)

/* Initialises logging at a particular level.
Parameters:
pcLogFile CHARACTER
poLogLevel OpenEdge.Logging.LogLevelEnum
Top

PUBLIC InitializeLogging (character, LogLevelEnum)

/* Initialises logging at a particular level.
This is a public, previously-published API and we need to
support a map back to the OE.Core enums
Parameters:
pcLogFile CHARACTER
poLogLevel OpenEdge.Core.LogLevelEnum
Top

PROTECTED LogMessage (character, LogLevelEnum)

/* Logs a message
Parameters:
pcMessage CHARACTER
poLevel OpenEdge.Logging.LogLevelEnum
Top

PROTECTED OnValidateExportRecord (DomainSystemExportEventArgs)

/* Publishes the ValidateExportRecord event to allow listeners to tweak the dump
Parameters:
poArgs OpenEdge.DataAdmin.Util.DomainSystemExportEventArgs
Top

PRIVATE ValidateExportFolder ()

/* Check whether the ExportFolder is the -T folder and report if so


Constructor Detail
Top

PUBLIC DomainSystemExport ()

/* Default constructor.
Top

PUBLIC DomainSystemExport (character)

/* Constructor.
Parameters:
pcName CHARACTER
Top

PUBLIC DomainSystemExport (character[])

/* Constructor.
Parameters:
pcName CHARACTER


Event Detail
Top

PUBLIC ValidateExportRecord (Object, DomainSystemExportEventArgs)

/* Published to allow customisation of whether a domain is exported, and with what data
Parameters:
poSender Progress.Lang.Object
poArgs OpenEdge.DataAdmin.Util.DomainSystemExportEventArgs


Property Detail
Top

PUBLIC CHARACTER DbName

Returns CHARACTER
Top

PUBLIC CHARACTER DomainConfigFile

Returns CHARACTER
Top

PUBLIC CHARACTER DomainKeysFile

Returns CHARACTER
Top

PUBLIC CHARACTER ExportFolder

Returns CHARACTER
Top

PUBLIC LOGICAL MakeDomainSSO

Returns LOGICAL


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0