com.atlassian.jira.functest.framework.admin
Interface EditPopServerConfiguration

All Known Implementing Classes:

DefaultEditPopServerConfiguration

public interface EditPopServerConfiguration

Represents the form used to edit the configuration of a POP/IMAP Server.

Since:

v4.3

Method Summary

EditPopServerConfiguration	setDescription(String description) Sets the description field to an specified value.
EditPopServerConfiguration	setHostName(String hostName) Sets the host name field to an specified value.
EditPopServerConfiguration	setName(String name) Sets the name field to an specified value.
EditPopServerConfiguration	setPassword(String password) Sets the password field to an specified value.
EditPopServerConfiguration	setPort(String portNumber) Sets the port field to an specified value.
EditPopServerConfiguration	setProtocol(String protocol) Sets the protocol select list to an specified option.
EditPopServerConfiguration	setTimeout(String timeout) Sets the timeout field to an specified value.
EditPopServerConfiguration	setUserName(String userName) Sets the user name field to an specified value.
MailServerAdministration	update() Submits the edit POP/IMAP server configuration form.

Method Detail

setName

EditPopServerConfiguration setName(String name)

Sets the name field to an specified value. This can not be blank.

Parameters:

name - The value of the name to set.

Returns:

This instance of the Edit Pop Server Configuration form.

setDescription

EditPopServerConfiguration setDescription(String description)

Sets the description field to an specified value. This field is optional and can be blank.

Parameters:

description - The value of the description to set.

Returns:

This instance of the Edit Pop Server Configuration form.

setProtocol

EditPopServerConfiguration setProtocol(String protocol)

Sets the protocol select list to an specified option. The default option is POP.

Parameters:

protocol - The value of the protocol to set. This must be one of the display values of the available options in the select list (POP, SECURE_POP, IMAP, SECURE_IMAP)

Returns:

This instance of the Edit Pop Server Configuration form.

setHostName

EditPopServerConfiguration setHostName(String hostName)

Sets the host name field to an specified value. This can not be blank.

Parameters:

hostName - The value of the host name to set.

Returns:

This instance of the Edit Pop Server Configuration form.

setPort

EditPopServerConfiguration setPort(String portNumber)

Sets the port field to an specified value. This field is optional and can be blank, if left blank the port will be set to the default value for the selected protocol.

Parameters:

portNumber - The value of the port to set.

Returns:

This instance of the Edit Pop Server Configuration form.

setTimeout

EditPopServerConfiguration setTimeout(String timeout)

Sets the timeout field to an specified value. This is optional and can be blank. If left blank it will default to 10000 milliseconds.

Parameters:

timeout - The value of the timeout to set.

Returns:

This instance of the Edit Pop Server Configuration form.

setUserName

EditPopServerConfiguration setUserName(String userName)

Sets the user name field to an specified value. This is a mandatory field and can not be left blank.

Parameters:

userName - The value of the user name to set.

Returns:

This instance of the Edit Pop Server Configuration form.

setPassword

EditPopServerConfiguration setPassword(String password)

Sets the password field to an specified value. It is mandatory to call this method before calling update() to submit the form, this is because the field is always set blank when the update form is displayed.

Parameters:

password - The value of the password to set.

Returns:

This instance of the Edit Pop Server Configuration form.

update

MailServerAdministration update()
                                throws DefaultEditPopServerConfiguration.PasswordIsMandatoryException

Submits the edit POP/IMAP server configuration form.

Returns:

The Mail Server Administration page instance that is displayed after submitting the form.

Throws:

DefaultEditPopServerConfiguration.PasswordIsMandatoryException - if no value has been set for the password field, you should always call setPassword(String) before calling this method.