org.llorllale.youtrack.api.session

Class UsernamePassword

java.lang.Object

org.llorllale.youtrack.api.session.UsernamePassword

All Implemented Interfaces:

Login

public final class UsernamePassword
extends Object
implements Login

A login for the simple username/password use case.

Since:

0.1.0

Author:

George Aristy (george.aristy@gmail.com)

See Also:

Login

Constructor Summary

Constructors

Constructor and Description
UsernamePassword(URL youtrackUrl, String username, char[] password) Ctor.

Method Summary

Modifier and Type	Method and Description
Session	session() A Session for this Login.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsernamePassword

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

Ctor.

Parameters:

youtrackUrl - the URL of the YouTrack API endpoint

username - the principal

password - the credentials

Since:

0.1.0

See Also:

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

Method Detail

session

public Session session()
                throws AuthenticationException,
                       IOException

Description copied from interface: Login

A Session for this Login.

Specified by:

session 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