com.atlassian.confluence.setup.actions

Class SetupClusterAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.setup.actions.AbstractSetupAction

com.atlassian.confluence.setup.actions.SetupClusterAction

All Implemented Interfaces:

WebInterface, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

public class SetupClusterAction
extends AbstractSetupAction

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SetupClusterAction.ClusterableInterface

Field Summary

Fields inherited from class com.atlassian.confluence.setup.actions.AbstractSetupAction

DEMO_CONTENT_ZIP_FILE, SETUP_CLUSTER_TO_STANDALONE, SETUP_CONTENT_BLANK, SETUP_CONTENT_DEMO, SETUP_CONTENT_IMPORT, SETUP_CUSTOM, SETUP_DB_CLUSTER_CONN_TYPE, SETUP_DB_CONN_TYPE, SETUP_DB_DATASOURCE, SETUP_DB_EMBEDDED, SETUP_DB_STANDARD, SETUP_DB_TYPE_DATASOURCE, SETUP_DB_TYPE_STANDARD, SETUP_PATHS, SETUP_QUICK, SETUP_SESSION_ID_KEY, SETUP_SKIP_TO_NEXT_STEP, SETUP_SKIP_TO_NEXT_STEP_CLUSTER, SETUP_USER_INTERNAL, SETUP_USER_JAACS

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

accessModeService, CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, personService, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
SetupClusterAction()

Method Summary

Modifier and Type	Method and Description
String	doDefault() This method acts as the initial entry point for cluster config during the setup wizard flow.
String	execute() This method performs the actual cluster bootstrap.
String	getAccessKey()
String	getAwsAuthMethod()
List	getClusterableInterfaces()
String	getClusterAddressString()
ClusterConfigurationHelperInternal	getClusterConfigurationHelper()
String	getClusterHome()
ClusterInformation	getClusterInformation()
ClusterManager	getClusterManager()
String	getClusterName()
String	getClusterPeersString()
String	getGenerateClusterAddress()
String	getGenerateClusterAddressSubmitted()
String	getHostHeader()
String	getIamRole()
String	getJoinMethod()
String	getNetworkInterface()
String	getRegion()
String	getSecretKey()
String	getSecurityGroupName()
String	getSetupClusterType()
SharedConfigurationMap	getSharedConfig() Deprecated. since 5.9
String	getTagKey()
String	getTagValue()
boolean	isAws()
boolean	isAwsIamRoleAuth()
boolean	isAwsSecretKeyAuth()
boolean	isGenerateAddress()
boolean	isMulticast()
boolean	isServerToDataCenterMigration()
boolean	isTcpIp()
boolean	isThisNodeClustered() Deprecated. since 5.9
void	setAccessKey(String accessKey)
void	setAwsAuthMethod(String awsAuthMethod)
void	setClusterAddressString(String clusterAddressString)
void	setClusterConfigurationHelper(ClusterConfigurationHelperInternal clusterConfigurationHelper)
void	setClusterHome(String clusterHome)
void	setClusterManager(ClusterManager clusterManager)
void	setClusterName(String clusterName)
void	setClusterPeersString(String clusterPeersString)
void	setClusterSharedDataManager(SharedDataManager clusterSharedDataManager)
void	setGenerateClusterAddress(String generateClusterAddress)
void	setGenerateClusterAddressSubmitted(String generateClusterAddressSubmitted)
void	setHostHeader(String hostHeader)
void	setIamRole(String iamRole)
void	setJoinMethod(String joinMethod)
void	setNetworkInterface(String networkInterface)
void	setRegion(String region)
void	setSecretKey(String secretKey)
void	setSecurityGroupName(String securityGroupName)
void	setSetupClusterType(String setupClusterType)
void	setTagKey(String tagKey)
void	setTagValue(String tagValue)
void	validate() This method is called by XWork to validate the cluster setup parameters that are entered into the wizard form.

Methods inherited from class com.atlassian.confluence.setup.actions.AbstractSetupAction

getBootstrapManager, getContainerManager, getLocale, getServerId, getSetupPersister, getSetupSessionId, getSingletonFromMainContext, getSupportEntitlementNumber, getXsrfToken, getXsrfTokenGenerator, isPermitted, retrieveSingletonFromMainContext, setBootstrapSidManager, setContainerManager, setLicenseService, setSetupPersister, setXsrfTokenGenerator, transitionFromColdToTenantedState, transitionFromColdToVacantState, transitionFromVacantToTenantedState

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getCancel, getCancelResult, getConfluenceAccessManager, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageJs, getLanguageManager, getLanguageUserFriendly, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUserAccessor, getUserByName, getUserFullName, getUserHasBrowseUsersPermission, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiDateFormatService, setApiPersonService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, withServletRequestSupplier

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SetupClusterAction

public SetupClusterAction()

Method Detail

validate

public void validate()

This method is called by XWork to validate the cluster setup parameters that are entered into the wizard form.

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface com.opensymphony.xwork.Validateable

Overrides:

validate in class com.opensymphony.xwork.ActionSupport

doDefault

public String doDefault()
                 throws Exception

This method acts as the initial entry point for cluster config during the setup wizard flow.

The application config (i.e. confluence.cfg.xml) is consulted to see if any of the cluster setup parameters have already been configured, and if so it populates the action's fields with those parameters, and then redirects (via xwork.xml) to the execute() method, where the cluster actually gets bootstrapped. This generally only happens to support the AWS Quick Start template, where the confluence.cfg.xml is pre-generated with the AWS cluster discovery parameter.

If the application config is *not* pre-populated (the normal case), then we redirect to the input form.

Overrides:

doDefault in class ConfluenceActionSupport

Returns:

the action result

Throws:

Exception - if something goes wrong

execute

public String execute()
               throws Exception

This method performs the actual cluster bootstrap. The config parameters will have been provided either via the wizard form, or via pre-configured app config parameters via doDefault().

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class com.opensymphony.xwork.ActionSupport

Throws:

Exception

setSetupClusterType

public void setSetupClusterType(String setupClusterType)

getSetupClusterType

public String getSetupClusterType()

isThisNodeClustered

@Deprecated
public boolean isThisNodeClustered()

Deprecated. since 5.9

getSharedConfig

@Deprecated
public SharedConfigurationMap getSharedConfig()

Deprecated. since 5.9

getClusterInformation

public ClusterInformation getClusterInformation()

getClusterName

public String getClusterName()

setClusterName

public void setClusterName(String clusterName)

getClusterHome

public String getClusterHome()

setClusterHome

public void setClusterHome(String clusterHome)

getNetworkInterface

public String getNetworkInterface()

setNetworkInterface

public void setNetworkInterface(String networkInterface)

setClusterManager

public void setClusterManager(ClusterManager clusterManager)

getClusterManager

public ClusterManager getClusterManager()

getClusterConfigurationHelper

public ClusterConfigurationHelperInternal getClusterConfigurationHelper()

setClusterConfigurationHelper

public void setClusterConfigurationHelper(ClusterConfigurationHelperInternal clusterConfigurationHelper)

getClusterableInterfaces

public List getClusterableInterfaces()

getClusterAddressString

public String getClusterAddressString()

setClusterAddressString

public void setClusterAddressString(String clusterAddressString)

getGenerateClusterAddress

public String getGenerateClusterAddress()

setGenerateClusterAddress

public void setGenerateClusterAddress(String generateClusterAddress)

getGenerateClusterAddressSubmitted

public String getGenerateClusterAddressSubmitted()

setGenerateClusterAddressSubmitted

public void setGenerateClusterAddressSubmitted(String generateClusterAddressSubmitted)

getClusterPeersString

public String getClusterPeersString()

setClusterPeersString

public void setClusterPeersString(String clusterPeersString)

setClusterSharedDataManager

public void setClusterSharedDataManager(SharedDataManager clusterSharedDataManager)

getJoinMethod

public String getJoinMethod()

isMulticast

public boolean isMulticast()

isTcpIp

public boolean isTcpIp()

isAws

public boolean isAws()

isGenerateAddress

public boolean isGenerateAddress()

isServerToDataCenterMigration

public boolean isServerToDataCenterMigration()

setJoinMethod

public void setJoinMethod(String joinMethod)

getAwsAuthMethod

public String getAwsAuthMethod()

setAwsAuthMethod

public void setAwsAuthMethod(String awsAuthMethod)

isAwsSecretKeyAuth

public boolean isAwsSecretKeyAuth()

isAwsIamRoleAuth

public boolean isAwsIamRoleAuth()

getAccessKey

public String getAccessKey()

setAccessKey

public void setAccessKey(String accessKey)

getSecretKey

public String getSecretKey()

setSecretKey

public void setSecretKey(String secretKey)

getIamRole

public String getIamRole()

setIamRole

public void setIamRole(String iamRole)

getRegion

public String getRegion()

setRegion

public void setRegion(String region)

getHostHeader

public String getHostHeader()

setHostHeader

public void setHostHeader(String hostHeader)

getSecurityGroupName

public String getSecurityGroupName()

setSecurityGroupName

public void setSecurityGroupName(String securityGroupName)

getTagKey

public String getTagKey()

setTagKey

public void setTagKey(String tagKey)

getTagValue

public String getTagValue()

setTagValue

public void setTagValue(String tagValue)