Skip to content

Commit 11f870d

Browse files
committed
Clarified Javadocs related to the various login methods (#128).
1 parent e65e882 commit 11f870d

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

src/main/java/org/gitlab4j/api/GitLabApi.java

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,8 @@ class Oauth2Api extends AbstractApi {
178178
* <p>Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
179179
* using returned private token and the specified GitLab API version.</p>
180180
*
181-
* NOTE: This functionality is not available on GitLab servers 10.2 and above.
181+
* <strong>NOTE</strong: For GitLab servers 10.2 and above this will utilize OAUTH2 for login. For GitLab servers prior to
182+
* 10.2, the Session API login is utilized.
182183
*
183184
* @param apiVersion the ApiVersion specifying which version of the API to use
184185
* @param url GitLab URL
@@ -195,7 +196,8 @@ public static GitLabApi login(ApiVersion apiVersion, String url, String username
195196
* <p>Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
196197
* using returned private token using GitLab API version 4.</p>
197198
*
198-
* NOTE: This functionality is not available on GitLab servers 10.2 and above.
199+
* <strong>NOTE</strong: For GitLab servers 10.2 and above this will utilize OAUTH2 for login. For GitLab servers prior to
200+
* 10.2, the Session API login is utilized.
199201
*
200202
* @param url GitLab URL
201203
* @param username user name for which private token should be obtained
@@ -211,7 +213,8 @@ public static GitLabApi login(String url, String username, String password) thro
211213
* <p>Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
212214
* using returned private token and the specified GitLab API version.</p>
213215
*
214-
* NOTE: This functionality is not available on GitLab servers 10.2 and above.
216+
* <strong>NOTE</strong: For GitLab servers 10.2 and above this will utilize OAUTH2 for login. For GitLab servers prior to
217+
* 10.2, the Session API login is utilized.
215218
*
216219
* @param apiVersion the ApiVersion specifying which version of the API to use
217220
* @param url GitLab URL
@@ -253,7 +256,8 @@ public static GitLabApi login(ApiVersion apiVersion, String url, String username
253256
* <p>Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
254257
* using returned private token using GitLab API version 4.</p>
255258
*
256-
* NOTE: This functionality is not available on GitLab servers 10.2 and above.
259+
* <strong>NOTE</strong: For GitLab servers 10.2 and above this will utilize OAUTH2 for login. For GitLab servers prior to
260+
* 10.2, the Session API login is utilized.
257261
*
258262
* @param url GitLab URL
259263
* @param username user name for which private token should be obtained
@@ -269,26 +273,27 @@ public static GitLabApi login(String url, String username, String password, bool
269273
/**
270274
* <p>Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
271275
* using returned private token and specified GitLab API version.</p>
272-
*
273-
* NOTE: This functionality is not available on GitLab servers 10.2 and above.
274276
*
275277
* @param url GitLab URL
276278
* @param username user name for which private token should be obtained
277279
* @param password password for a given {@code username}
278280
* @return new {@code GitLabApi} instance configured for a user-specific token
279281
* @throws GitLabApiException GitLabApiException if any exception occurs during execution
280-
* @deprecated As of release 4.2.0, replaced by {@link #login(String, String, String)}
282+
* @deprecated As of release 4.2.0, replaced by {@link #login(String, String, String)}, will be removed in 5.0.0
281283
*/
282284
@Deprecated
283285
public static GitLabApi create(String url, String username, String password) throws GitLabApiException {
284286
return (GitLabApi.login(url, username, password));
285287
}
286288

287289
/**
288-
* If this instance was created with {@link #login(String, String, String)} this method will
289-
* return the Session instance returned by the GitLab API on login, otherwise returns null.
290+
* <p>If this instance was created with {@link #login(String, String, String)} this method will
291+
* return the Session instance returned by the GitLab API on login, otherwise returns null.</p>
292+
*
293+
* <strong>NOTE</strong: For GitLab servers 10.2 and above this method will always return null.
290294
*
291295
* @return the Session instance
296+
* @deprecated This method will be removed in Release 5.0.0
292297
*/
293298
public Session getSession() {
294299
return session;

0 commit comments

Comments
 (0)