Class Driver
- java.lang.Object
-
- com.sun.identity.install.tools.configurator.Driver
-
- All Implemented Interfaces:
ICommonToolsConstants
,InstallConstants
- Direct Known Subclasses:
CustomInstallDriver
,InstallDriver
,MigrateDriver
,MultipleUninstallDriver
,SingleUninstallDriver
public abstract class Driver extends Object implements InstallConstants
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
Driver.ExecutionStatus
-
Field Summary
Fields Modifier and Type Field Description static int
INT_EXIT_LOOP
static int
INT_RUN_DISPLAY_SUMMARY
static int
INT_RUN_IFINDER_INTERACTIONS
static int
INT_RUN_INTERACTIONS
static String
LOC_DR_MSG_PRODUCT_AGENT_TAGS_FILE_NAME
Field LOC_DR_MSG_PRODUCT_AGENT_TAGS_FILE_NAMEstatic String
LOC_DR_MSG_PRODUCT_AUDIT_DIR
Field LOC_DR_MSG_PRODUCT_AUDIT_DIRstatic String
LOC_DR_MSG_PRODUCT_CONFIG_FILE_NAME
Field LOC_DR_MSG_PRODUCT_CONFIG_FILE_NAMEstatic String
LOC_DR_MSG_PRODUCT_DEBUG_DIR
Field LOC_DR_MSG_PRODUCT_DEBUG_DIRstatic String
LOC_DR_MSG_PRODUCT_INSTANCE_NAME
Field LOC_DR_MSG_PRODUCT_INSTANCE_NAMEstatic String
LOC_DR_MSG_SUMM_INFO_BEGIN
Field LOC_DR_MSG_SUMM_INFO_BEGINstatic String
LOC_DR_MSG_SUMM_INFO_BEGIN_LINE
Field LOC_DR_MSG_SUMM_INFO_BEGIN_LINEstatic String
LOC_DR_MSG_SUMM_INFO_END
Field LOC_DR_MSG_SUMM_INFO_ENDstatic String
LOC_DR_MSG_USER_ABORT
static String
LOC_DR_MSG_VERSION_INFO
Field LOC_DR_MSG_VERSION_INFO-
Fields inherited from interface com.sun.identity.install.tools.admin.ICommonToolsConstants
FILE_SEP, INSTANCE_AUDIT_DIR_NAME, INSTANCE_CONFIG_DIR_NAME, INSTANCE_DEBUG_DIR_NAME, INSTANCE_LIB_DIR_NAME, INSTANCE_LOCALE_DIR_NAME, INSTANCE_LOGS_DIR_NAME, LINE_SEP
-
Fields inherited from interface com.sun.identity.install.tools.configurator.InstallConstants
INT_OPERATION_TYPE_REGULAR, INT_OPERATION_TYPE_SAVE_RESPONSE, INT_OPERATION_TYPE_USE_RESPONSE, LOC_DR_ERR_APP_SERVER_HOME_LOCATOR, LOC_DR_ERR_CORRUPT_PRODUCT_INSTALL, LOC_DR_ERR_INVALID_INSTALL_HOME, LOC_DR_ERR_PRODUCT_ALREADY_MIGRATED, LOC_DR_ERR_PRODUCT_LOCATOR_BACKUP, LOC_DR_ERR_PRODUCT_LOCATOR_READ, LOC_DR_ERR_PRODUCT_LOCATOR_WRITE, LOC_DR_MSG_PRODUCT_SUMM_INFO_BEGIN, LOC_DR_MSG_PRODUCT_SUMM_INFO_BEGIN_LINE, LOC_DR_MSG_PRODUCT_SUMM_INFO_END, LOC_IS_ERR_LOAD_INSTALL_STATE, LOC_IS_ERR_SAVE_INSTALL_STATE, STR_AUDIT_DIR_PREFIX_TAG, STR_BEGIN_END_LINE_MARKER, STR_CONFIG_AGENT_CONFIG_FILE_PATH_TAG, STR_CONFIG_AGENT_MIGRATE_FILE_PATH_TAG, STR_CONFIG_DIR_PREFIX_MIGRATE_TAG, STR_CONFIG_DIR_PREFIX_TAG, STR_CONFIG_FILE_PATH_TAG, STR_CREATE_AGENT_PROFILE_KEY, STR_CREATE_AGENT_PROFILE_NAME, STR_CUSTOM, STR_DEBUG_DIR_PREFIX_TAG, STR_INSTALL, STR_INSTANCE_NAME_MIGRATE_TAG, STR_IS_GLOBAL_DATA_ID, STR_LOG_CONFIG_FILE_PATH, STR_LOG_CONFIG_FILENAME, STR_MIGRATE, STR_SAVE_AGENT_INSTANCE_NAME_KEY, STR_SAVE_REMOTE_AGENT_INSTALL_DIR_KEY, STR_UNINSTALL, STR_VERSION_FILE_NAME
-
-
Constructor Summary
Constructors Constructor Description Driver()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
checkInstanceConfiguration(InstallState state)
void
createResponseFile(String fileName, com.sun.identity.install.tools.configurator.InstFinderInteractionsRunner iFinderRunner, com.sun.identity.install.tools.configurator.InteractionsRunner iRunner)
Driver.ExecutionStatus
displaySummary(com.sun.identity.install.tools.configurator.InstFinderInteractionsRunner iFinderRunner, com.sun.identity.install.tools.configurator.InteractionsRunner iRunner, DisplaySummaryHandler summaryHandler)
void
executeAllInteractions(com.sun.identity.install.tools.configurator.InstFinderInteractionsRunner iFinderRunner, com.sun.identity.install.tools.configurator.InteractionsRunner iRunner, DisplaySummaryHandler summaryHandler)
Driver.ExecutionStatus
executeIFinderInteractions(com.sun.identity.install.tools.configurator.InstFinderInteractionsRunner iFinderRunner, com.sun.identity.install.tools.configurator.InteractionsRunner iRunner, boolean startFromLast)
Driver.ExecutionStatus
executeInstanceInteractions(com.sun.identity.install.tools.configurator.InteractionsRunner iRunner, boolean startFromLast)
InstallState
getInstallState()
LocalizedMessage
getLogFilePathMessage(InstallLogger installLog, String installLogLocKey)
int
getOperationType()
InstallRunInfo
getRunInfo()
com.sun.identity.install.tools.configurator.ServerLocatorHandler
getServerLocatorHandler()
boolean
isSilentMode()
void
printConsoleEmptyLine()
void
printConsoleMessage(I18NInfo messageInfo)
void
printConsoleMessage(LocalizedMessage message)
void
printConsoleMessageWithMarkers(I18NInfo messageInfo)
void
setInstallState(InstallState installState)
void
setMigrateServerLocatorHandler(InstallRunInfo installRunInfo)
void
setOperationType(int type)
void
setRunInfo(InstallRunInfo info)
void
setServerLocatorHandler(InstallRunInfo installRunInfo)
void
updateStateAccess(InstallState installState, com.sun.identity.install.tools.configurator.InstFinderInteractionsRunner iFinderRunner, com.sun.identity.install.tools.configurator.InteractionsRunner iRunner)
void
writeSummDispMessToInstLog(ArrayList summMessages, InstallLogger installLog)
void
writeVersionInfoToLog(InstallLogger installLog, String descriptionLocKey, String descrptionFmtLineLocKey)
-
-
-
Field Detail
-
LOC_DR_MSG_USER_ABORT
public static final String LOC_DR_MSG_USER_ABORT
- See Also:
- Constant Field Values
-
LOC_DR_MSG_SUMM_INFO_BEGIN
public static final String LOC_DR_MSG_SUMM_INFO_BEGIN
Field LOC_DR_MSG_SUMM_INFO_BEGIN- See Also:
- Constant Field Values
-
LOC_DR_MSG_SUMM_INFO_BEGIN_LINE
public static final String LOC_DR_MSG_SUMM_INFO_BEGIN_LINE
Field LOC_DR_MSG_SUMM_INFO_BEGIN_LINE- See Also:
- Constant Field Values
-
LOC_DR_MSG_SUMM_INFO_END
public static final String LOC_DR_MSG_SUMM_INFO_END
Field LOC_DR_MSG_SUMM_INFO_END- See Also:
- Constant Field Values
-
LOC_DR_MSG_PRODUCT_INSTANCE_NAME
public static final String LOC_DR_MSG_PRODUCT_INSTANCE_NAME
Field LOC_DR_MSG_PRODUCT_INSTANCE_NAME- See Also:
- Constant Field Values
-
LOC_DR_MSG_PRODUCT_CONFIG_FILE_NAME
public static final String LOC_DR_MSG_PRODUCT_CONFIG_FILE_NAME
Field LOC_DR_MSG_PRODUCT_CONFIG_FILE_NAME- See Also:
- Constant Field Values
-
LOC_DR_MSG_PRODUCT_DEBUG_DIR
public static final String LOC_DR_MSG_PRODUCT_DEBUG_DIR
Field LOC_DR_MSG_PRODUCT_DEBUG_DIR- See Also:
- Constant Field Values
-
LOC_DR_MSG_PRODUCT_AUDIT_DIR
public static final String LOC_DR_MSG_PRODUCT_AUDIT_DIR
Field LOC_DR_MSG_PRODUCT_AUDIT_DIR- See Also:
- Constant Field Values
-
LOC_DR_MSG_VERSION_INFO
public static final String LOC_DR_MSG_VERSION_INFO
Field LOC_DR_MSG_VERSION_INFO- See Also:
- Constant Field Values
-
LOC_DR_MSG_PRODUCT_AGENT_TAGS_FILE_NAME
public static final String LOC_DR_MSG_PRODUCT_AGENT_TAGS_FILE_NAME
Field LOC_DR_MSG_PRODUCT_AGENT_TAGS_FILE_NAME- See Also:
- Constant Field Values
-
INT_RUN_IFINDER_INTERACTIONS
public static final int INT_RUN_IFINDER_INTERACTIONS
- See Also:
- Constant Field Values
-
INT_RUN_INTERACTIONS
public static final int INT_RUN_INTERACTIONS
- See Also:
- Constant Field Values
-
INT_RUN_DISPLAY_SUMMARY
public static final int INT_RUN_DISPLAY_SUMMARY
- See Also:
- Constant Field Values
-
INT_EXIT_LOOP
public static final int INT_EXIT_LOOP
- See Also:
- Constant Field Values
-
-
Method Detail
-
checkInstanceConfiguration
public abstract void checkInstanceConfiguration(InstallState state) throws InstallException
- Throws:
InstallException
-
executeAllInteractions
public void executeAllInteractions(com.sun.identity.install.tools.configurator.InstFinderInteractionsRunner iFinderRunner, com.sun.identity.install.tools.configurator.InteractionsRunner iRunner, DisplaySummaryHandler summaryHandler) throws InstallException
- Throws:
InstallException
-
executeIFinderInteractions
public Driver.ExecutionStatus executeIFinderInteractions(com.sun.identity.install.tools.configurator.InstFinderInteractionsRunner iFinderRunner, com.sun.identity.install.tools.configurator.InteractionsRunner iRunner, boolean startFromLast) throws InstallException
- Throws:
InstallException
-
executeInstanceInteractions
public Driver.ExecutionStatus executeInstanceInteractions(com.sun.identity.install.tools.configurator.InteractionsRunner iRunner, boolean startFromLast) throws InstallAbortException, InstallException
-
displaySummary
public Driver.ExecutionStatus displaySummary(com.sun.identity.install.tools.configurator.InstFinderInteractionsRunner iFinderRunner, com.sun.identity.install.tools.configurator.InteractionsRunner iRunner, DisplaySummaryHandler summaryHandler) throws InstallAbortException, InstallException
-
createResponseFile
public void createResponseFile(String fileName, com.sun.identity.install.tools.configurator.InstFinderInteractionsRunner iFinderRunner, com.sun.identity.install.tools.configurator.InteractionsRunner iRunner) throws InstallException
- Throws:
InstallException
-
updateStateAccess
public void updateStateAccess(InstallState installState, com.sun.identity.install.tools.configurator.InstFinderInteractionsRunner iFinderRunner, com.sun.identity.install.tools.configurator.InteractionsRunner iRunner)
-
writeSummDispMessToInstLog
public void writeSummDispMessToInstLog(ArrayList summMessages, InstallLogger installLog)
-
getLogFilePathMessage
public LocalizedMessage getLogFilePathMessage(InstallLogger installLog, String installLogLocKey)
-
printConsoleMessage
public void printConsoleMessage(LocalizedMessage message)
-
printConsoleEmptyLine
public void printConsoleEmptyLine()
-
writeVersionInfoToLog
public void writeVersionInfoToLog(InstallLogger installLog, String descriptionLocKey, String descrptionFmtLineLocKey)
-
printConsoleMessageWithMarkers
public void printConsoleMessageWithMarkers(I18NInfo messageInfo)
-
printConsoleMessage
public void printConsoleMessage(I18NInfo messageInfo)
-
isSilentMode
public boolean isSilentMode()
-
getInstallState
public InstallState getInstallState()
-
getOperationType
public int getOperationType()
-
getRunInfo
public InstallRunInfo getRunInfo()
-
setInstallState
public void setInstallState(InstallState installState)
-
getServerLocatorHandler
public com.sun.identity.install.tools.configurator.ServerLocatorHandler getServerLocatorHandler()
-
setRunInfo
public void setRunInfo(InstallRunInfo info)
-
setServerLocatorHandler
public void setServerLocatorHandler(InstallRunInfo installRunInfo)
-
setMigrateServerLocatorHandler
public void setMigrateServerLocatorHandler(InstallRunInfo installRunInfo)
-
setOperationType
public void setOperationType(int type)
-
-