com.atlassian.confluence.selenium.client

Class ConfluenceLogin

java.lang.Object

com.atlassian.confluence.selenium.client.ConfluenceLogin

All Implemented Interfaces:

SeleniumLogin

public class ConfluenceLogin
extends Object
implements SeleniumLogin

Logs users in and out of Confluence via the Confluence login screen

Since:

4.1

Constructor Summary

Constructors

Constructor and Description
ConfluenceLogin(ConfluenceSeleniumClient confluenceClient)

Method Summary

Modifier and Type	Method and Description
String	getLogoutPath() The relative path of the logout screen.
void	logIn(User user, String destination, long timeoutMillis, boolean rememberMe, String language) Logs the specified User in and redirects them to a destination page (if specified).
void	logOut() Logs the current user out, after which the browser can be assumed to be on a "Logged Out" screen.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfluenceLogin

public ConfluenceLogin(ConfluenceSeleniumClient confluenceClient)

Method Detail

logIn

public void logIn(User user,
                  String destination,
                  long timeoutMillis,
                  boolean rememberMe,
                  String language)

Description copied from interface: SeleniumLogin

Logs the specified User in and redirects them to a destination page (if specified).

Specifying a destination is preferred so that the calling test doesn't waste time loading the dashboard - the browser will be directed to the destination page directly from the Login screen.

Specified by:

logIn in interface SeleniumLogin

Parameters:

user - a Confluence user

destination - (optional) a relative path (after the context)

timeoutMillis - how long to wait for the Dashboard or destination page to load

rememberMe - whether the "Remember Me" option on the login form should be checked

language - (optional) the language to load the destination page in

logOut

public void logOut()

Description copied from interface: SeleniumLogin

Logs the current user out, after which the browser can be assumed to be on a "Logged Out" screen.

Specified by:

logOut in interface SeleniumLogin

getLogoutPath

public String getLogoutPath()

Description copied from interface: SeleniumLogin

The relative path of the logout screen. Should only be used by the implementing class or in the Suite facade.

Specified by:

getLogoutPath in interface SeleniumLogin