org.llorllale.youtrack.api.session

Class UsernamePasswordLogin

java.lang.Object

org.llorllale.youtrack.api.session.UsernamePasswordLogin

All Implemented Interfaces:

Login

public final class UsernamePasswordLogin
extends Object
implements Login

A login for the simple username/password use case.

Implementation note: the login() method can only be called ONCE on an instance of UsernamePassordLogin because the username and password fields are set to null internally in the first call due to security concerns. Therefore, you need to create another instance of UsernamePasswordLogin if the same credentials are to be retried. Further calls to the login() method will result in an IllegalStateException being thrown.

Since:

0.1.0

Author:

George Aristy (george.aristy@gmail.com)

See Also:

Login

Constructor Summary

Constructors

Constructor and Description
UsernamePasswordLogin(URL youtrackUrl, String username, char[] password) Assumes the default http client as the http client to use.

Method Summary

Modifier and Type	Method and Description
Session	login() Performs the login function and returns a Session with sufficient state to allow further transactions with YouTrack.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsernamePasswordLogin

public UsernamePasswordLogin(URL youtrackUrl,
                             String username,
                             char[] password)

Assumes the default http client as the http client to use.

Parameters:

youtrackUrl - the URL of the YouTrack API endpoint

username - the principal

password - the credentials

Since:

0.1.0

See Also:

UsernamePasswordLogin(URL, String, char[], HttpClient)

Method Detail

login

public Session login()
              throws AuthenticationException,
                     IOException

Description copied from interface: Login

Performs the login function and returns a Session with sufficient state to allow further transactions with YouTrack.

Specified by:

login in interface Login

Returns:

a session object with state usable for further transactions.

Throws:

AuthenticationException - if the login process fails due to invalid credentials

IOException - if the YouTrack endpoint is unreachable