com.github.noraui.browser

Class Auth

java.lang.Object

com.github.noraui.browser.Auth

public class Auth
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Auth.authenticationTypes
class	Auth.User Inner class representing an authenticated user.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PASSWORD
static String	SESSION_COOKIE
static String	UID

Constructor Summary

Constructors

Constructor and Description
Auth() Constructor.

Method Summary

Modifier and Type	Method and Description
static void	clear() Clears authentication data.
static org.openqa.selenium.Cookie	getAuthenticationCookie(String domainUrl) Returns a Cookie object by retrieving data from -Dcookie maven parameter.
static Auth	getInstance() Get auth singleton.
static String	getLogin() Gets current user login if direct authentication is used.
static String	getPassword() Gets current user password if direct authentication is used.
static boolean	isConnected() Returns true if current user is connected, false otherwise
static void	loadAuthenticationCookie(org.openqa.selenium.Cookie cookie) Loads authentication cookie in the current web browsers.
static void	setAuthenticationType(String type) Sets the authentication mode.
static void	setConnected(boolean isConnected) Save the value of current user's authentication (true if connected, false otherwise)
static String	usingAuthentication(String url) Process a given url using the current authentication mode.

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_COOKIE

public static final String SESSION_COOKIE

See Also:

Constant Field Values

UID

public static final String UID

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

See Also:

Constant Field Values

Constructor Detail

Auth

public Auth()

Constructor.

Method Detail

getInstance

public static Auth getInstance()

Get auth singleton.

Returns:

auth instance

setConnected

public static void setConnected(boolean isConnected)

Save the value of current user's authentication (true if connected, false otherwise)

Parameters:

isConnected - value of authentication

setAuthenticationType

public static void setAuthenticationType(String type)

Sets the authentication mode. Modes are listed here: Auth.authenticationTypes.

Parameters:

type - type of authentication

isConnected

public static boolean isConnected()

Returns true if current user is connected, false otherwise

Returns:

true if current user is connected, false otherwise

getLogin

public static String getLogin()

Gets current user login if direct authentication is used.

Returns:

the current user's login

getPassword

public static String getPassword()

Gets current user password if direct authentication is used.

Returns:

the current user's password

getAuthenticationCookie

public static org.openqa.selenium.Cookie getAuthenticationCookie(String domainUrl)
                                                          throws TechnicalException

Returns a Cookie object by retrieving data from -Dcookie maven parameter.

Parameters:

domainUrl - the domain on which the cookie is applied

Returns:

a Cookie with a name, value, domain and path.

Throws:

TechnicalException - with a message (no screenshot, no exception)

loadAuthenticationCookie

public static void loadAuthenticationCookie(org.openqa.selenium.Cookie cookie)

Loads authentication cookie in the current web browsers.

Parameters:

cookie - the Cookie instance to set to the current web browser.

usingAuthentication

public static String usingAuthentication(String url)

Process a given url using the current authentication mode.

Parameters:

url - url to access behind authentication

Returns:

the given url processed using the right authentication mode

clear

public static void clear()

Clears authentication data.