Package com.atlassian.confluence.setup.actions

Class AbstractSetupEmailAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.setup.actions.AbstractSetupEmailAction

All Implemented Interfaces:

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

Direct Known Subclasses:

CreateMailServerAction, EditMailServerAction

public abstract class AbstractSetupEmailAction
extends ConfluenceActionSupport

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractSetupEmailAction.FormData

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASIC_AUTH_KEY
static String	OAUTH_FLOW_SESSION_KEY
protected String	protocol

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, systemInformationService, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork2.ActionSupport

container

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
AbstractSetupEmailAction()

Method Summary

Modifier and Type	Method	Description
abstract String	buildRedirect(String flowId)
String	doDefault()	Convenient Action execution method which defaults to returning INPUT
protected abstract String	doDefaultInternal()
String	execute()
protected abstract String	executeInternal()
com.atlassian.sal.api.ApplicationProperties	getApplicationProperties()
String	getAuthorization()
List<HTMLPairType>	getAuthorizationList()
String	getAuthorize()
String	getEmailAddress()
String	getFlowId()
String	getFromName()
String	getHostname()
Long	getId()
List<HTMLPairType>	getIncomingProtocolList()
String	getJndiName()
com.atlassian.mail.server.MailServer	getMailServer()	Build the mail server from the form data
protected com.atlassian.mail.server.MailServerManager	getMailServerManager()
String	getName()
OAuth2Service	getOAuth2Service()
String	getPassword()
String	getPort()
String	getPrefix()
String	getProtocol()
String	getTestConnection()
String	getToken()
String	getUserName()
boolean	isPermitted()
boolean	isTlsRequired()
void	setApplicationProperties(com.atlassian.sal.api.ApplicationProperties applicationProperties)
void	setAuthorization(String authorization)
void	setAuthorize(String authorize)
void	setEmailAddress(String emailAddress)
void	setFlowId(String flowId)
void	setFromName(String fromName)
void	setHostname(String hostname)
void	setId(Long id)
void	setJndiName(String jndiName)
void	setMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager)
void	setName(String name)
void	setoAuth2Service(OAuth2Service oAuth2Service)	CAUTION: Never ever try to rename this method.
void	setPassword(String password)
void	setPort(String port)
void	setPrefix(String prefix)
void	setProtocol(String protocol)
void	setTestConnection(String testConnection)
void	setTlsRequired(boolean tls)
void	setToken(String token)
void	setUserName(String userName)
void	validate()
protected void	validateJNDIScheme()

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getBootstrapStatusProvider, getCancel, getCancelResult, getConfluenceAccessManager, getContentUiSupport, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocBean, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageJs, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, 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, setBootstrapStatusProvider, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, useSkipAccessCheck, withServletRequestSupplier

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getActionErrors, getActionMessages, getContainer, getFieldErrors, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opensymphony.xwork2.LocaleProvider

isValidLocale, isValidLocaleString

Field Detail

OAUTH_FLOW_SESSION_KEY

public static final String OAUTH_FLOW_SESSION_KEY

See Also:

Constant Field Values

BASIC_AUTH_KEY

public static final String BASIC_AUTH_KEY

See Also:

Constant Field Values

protocol

protected String protocol

Constructor Detail

AbstractSetupEmailAction

public AbstractSetupEmailAction()

Method Detail

isPermitted

public final boolean isPermitted()

Overrides:

isPermitted in class ConfluenceActionSupport

validate

public void validate()

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface com.opensymphony.xwork2.Validateable

Overrides:

validate in class com.opensymphony.xwork2.ActionSupport

doDefault

public String doDefault()
                 throws Exception

Description copied from class: ConfluenceActionSupport

Convenient Action execution method which defaults to returning INPUT

Overrides:

doDefault in class ConfluenceActionSupport

Throws:

Exception

doDefaultInternal

protected abstract String doDefaultInternal()
                                     throws Exception

Throws:

Exception

execute

public String execute()
               throws Exception

Specified by:

execute in interface com.opensymphony.xwork2.Action

Overrides:

execute in class com.opensymphony.xwork2.ActionSupport

Throws:

Exception

getMailServer

public com.atlassian.mail.server.MailServer getMailServer()

Build the mail server from the form data

Returns:

a MailServer instance

executeInternal

protected abstract String executeInternal()
                                   throws Exception

Throws:

Exception

getName

public String getName()

setName

public void setName(String name)

getEmailAddress

public String getEmailAddress()

setEmailAddress

public void setEmailAddress(String emailAddress)

getFromName

public String getFromName()

setFromName

public void setFromName(String fromName)

getPrefix

public String getPrefix()

setPrefix

public void setPrefix(String prefix)

getUserName

public String getUserName()

setUserName

public void setUserName(String userName)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getHostname

public String getHostname()

getPort

public String getPort()

setPort

public void setPort(String port)

setHostname

public void setHostname(String hostname)

isTlsRequired

public boolean isTlsRequired()

setTlsRequired

public void setTlsRequired(boolean tls)

getJndiName

public String getJndiName()

setJndiName

public void setJndiName(String jndiName)

getId

public Long getId()

setId

public void setId(Long id)

setProtocol

public void setProtocol(String protocol)

getProtocol

public String getProtocol()

setAuthorization

public void setAuthorization(String authorization)

getAuthorization

public String getAuthorization()

setToken

public void setToken(String token)

getToken

public String getToken()

setFlowId

public void setFlowId(String flowId)

getFlowId

public String getFlowId()

getAuthorize

public String getAuthorize()

setAuthorize

public void setAuthorize(String authorize)

setTestConnection

public void setTestConnection(String testConnection)

getTestConnection

public String getTestConnection()

setMailServerManager

public void setMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager)

getMailServerManager

protected com.atlassian.mail.server.MailServerManager getMailServerManager()

getOAuth2Service

public OAuth2Service getOAuth2Service()

setoAuth2Service

public void setoAuth2Service(OAuth2Service oAuth2Service)

CAUTION: Never ever try to rename this method. Otherwise, the oAuth2Service Spring bean won't be injected.

Parameters:

oAuth2Service - the bean to be injected

getApplicationProperties

public com.atlassian.sal.api.ApplicationProperties getApplicationProperties()

setApplicationProperties

public void setApplicationProperties(com.atlassian.sal.api.ApplicationProperties applicationProperties)

getIncomingProtocolList

public List<HTMLPairType> getIncomingProtocolList()

getAuthorizationList

public List<HTMLPairType> getAuthorizationList()

buildRedirect

public abstract String buildRedirect(String flowId)

validateJNDIScheme

protected void validateJNDIScheme()