org.llorllale.youtrack.api.session

Interface Login

All Known Implementing Classes:

Anonymous, PermanentToken, UsernamePassword

public interface Login

Performs the login.

YouTrack supports different authentication strategies (username/password, token, etc.), hence it's up to implementations to know what to do with login().

Since:

0.1.0

Author:

George Aristy (george.aristy@gmail.com)

See Also:

UsernamePassword, AnonymousLogin

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.

Method Detail

login

Session login()
       throws AuthenticationException,
              IOException

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

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

Since:

0.1.0