org.llorllale.youtrack.api.session

Class PermanentTokenLogin

java.lang.Object

org.llorllale.youtrack.api.session.PermanentTokenLogin

All Implemented Interfaces:

Login

public final class PermanentTokenLogin
extends Object
implements Login

A Login that makes use of YouTrack's permanent tokens feature to authorize 3rd party application integrations.

Since:

0.3.0

Author:

George Aristy (george.aristy@gmail.com)

Constructor Summary

Constructors

Constructor and Description
PermanentTokenLogin(URL youtrackUrl, String token) Ctor.

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

PermanentTokenLogin

public PermanentTokenLogin(URL youtrackUrl,
                           String token)

Ctor.

Parameters:

youtrackUrl - the YouTrack API's url

token - the YouTrack user's permanent token

Since:

0.3.0

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