org.llorllale.youtrack.api.session

Class AnonymousLogin

java.lang.Object

org.llorllale.youtrack.api.session.AnonymousLogin

All Implemented Interfaces:

Login

public final class AnonymousLogin
extends Object
implements Login

A Login for anonymous sessions if your YouTrack supports it (ie. the "guest" user is not banned).

Calling login() on an AnonymousLogin is guaranteed to always succeed.

Since:

0.1.0

Author:

George Aristy (george.aristy@gmail.com)

Constructor Summary

Constructors

Constructor and Description
AnonymousLogin(URL youtrackUrl) 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

AnonymousLogin

public AnonymousLogin(URL youtrackUrl)

Ctor.

Parameters:

youtrackUrl - the YouTrack API's url.

Since:

0.1.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