administrator.cfc

CFIDE.adminapi.administrator
Component administrator (administrator)

Basic Administrator functionality. Login, logout, Migration Wizard, and Setup Wizard.

hierarchy: WEB-INF.cftags.component
CFIDE.adminapi.base
CFIDE.adminapi.administrator
path: {web-root}\CFIDE\adminapi\administrator.cfc
serializable: Yes
properties:
methods: getAdminProperty, getMigrateCF5Flag*, getMigrateCF6Flag*, getMigrateCF7Flag*, getMigrateCF8Flag*, getMigrationFlag*, getMXMigrationFlag*, getSalt, getSetupEnableRDS*, getSetupOdbc*, getSetupSampleApps*, getSetupWizardFlag*, login, logout, setAdminProperty, setMigrateCF5Flag*, setMigrateCF6Flag*, setMigrateCF7Flag*, setMigrateCF8Flag*, setMigrationFlag*, setMXMigrationFlag*, setSetupEnableRDS*, setSetupOdbc*, setSetupSampleApps*, setSetupWizardFlag*
inherited methods: dump, getEdition, getInstallType, getJRunRootDir, isAdminUser, RDSInvoker, setJrunSN

* – private method

getAdminProperty
public boolean getAdminProperty ( required propertyName
)

Returns Migration Wizard or Setup Wizard status.

Output: suppressed
Parameters:
propertyName: any, required, propertyName – Migration or setup flag to be returned. Valid Properties are:

  • migrationFlag
  • MXMigrationFlag
  • SetupWizardFlag
  • migrateCF5
  • migrateCF6
  • setupSampleApps
  • setupOdbc
  • setupEnabldRds
getMigrateCF5Flag*
private getMigrateCF5Flag (

)

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getMigrateCF6Flag*
private getMigrateCF6Flag (

)

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getMigrateCF7Flag*
private getMigrateCF7Flag (

)

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getMigrateCF8Flag*
private getMigrateCF8Flag (

)

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

t”> getMigrationFlag*
private getMigrationFlag (

)

Indicates whether the ColdFusion 5 to ColdFusion Migration Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getMXMigrationFlag*
private getMXMigrationFlag (

)

Indicates whether the ColdFusion MX to ColdFusion 8 Migration Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getSalt
remote getSalt (

)

Get salt from server for Administrator login.

Output:

getSetupEnableRDS*
private boolean getSetupEnableRDS (

)

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getSetupOdbc*
private boolean getSetupOdbc (

)

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getSetupSampleApps*
private boolean getSetupSampleApps (

)

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

getSetupWizardFlag*
private getSetupWizardFlag (

)

Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed

login
remote boolean login ( required adminPassword, adminUserId="[runtime expression]", salt, rdsPasswordAllowed="false"
)

Authenticate the user for the length of the request. Required before accessing other methods of the Administrator API. Returns true if login successful.

Output: suppressed
Parameters:
adminPassword: any, required, adminPassword – ColdFusion Administrator password.
adminUserId: any, optional, adminUserId – ColdFusion Administrator User Id
salt: any, optional, salt – Used to generate an encrypted password. Internal use only; do not use.
rdsPasswordAllowed: any, optional, rdsPasswordAllowed – Allow the user to login and access the adminapi with the RDS password.

logout
remote logout (

)

Logout from the Administrator API.

Output:

setAdminProperty
public void setAdminProperty ( required propertyName, required propertyValue
)

Sets Migration Wizard or Setup Wizard status.

Output: suppressed
Parameters:
propertyName: any, required, propertyName – Migration or setup flag to be set. Valid properties are:

  • migrationFlag
  • MXMigrationFlag
  • SetupWizardFlag
  • migrateCF5
  • migrateCF6
  • setupSampleApps
  • setupOdbc
  • setupEnabldRds

propertyValue: any, required, propertyValue – Value for the migration or setup flag. Specify yes or no.

setMigrateCF5Flag*
private void setMigrateCF5Flag ( required boolean flag
)

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
flag: boolean, required, flag – Yes or No.

setMigrateCF6Flag*
private void setMigrateCF6Flag ( required boolean flag
)

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
flag: boolean, required, flag – Yes or No.

setMigrateCF7Flag*
private void setMigrateCF7Flag ( required boolean flag
)

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
flag: boolean, required, flag – Yes or No.

setMigrateCF8Flag*
private void setMigrateCF8Flag ( required boolean flag
)

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
flag: boolean, required, flag – Yes or No.

setMigrationFlag*
private void setMigrationFlag ( required boolean flag
)

Specifies whether the ColdFusion 5 to ColdFusion Migration Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
flag: boolean, required, flag – Yes or No.

setMXMigrationFlag*
private void setMXMigrationFlag ( required boolean flag
)

Specifies whether the ColdFusion MX to ColdFusion 8 Migration Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
flag: boolean, required, flag – Yes or No.

setSetupEnableRDS*
private void setSetupEnableRDS ( required boolean flag
)

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
flag: boolean, required, flag – Yes or No.

setSetupOdbc*
private void setSetupOdbc ( required boolean flag
)

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
flag: boolean, required, flag – Yes or No.

setSetupSampleApps*
private void setSetupSampleApps ( required boolean flag
)

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
flag: boolean, required, flag – Yes or No.

setSetupWizardFlag*
private void setSetupWizardFlag ( required boolean flag
)

Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time.

Output: suppressed
Parameters:
flag: boolean, required, flag – Yes or No.