Skip to content

Commit 118705f

Browse files
committed
correct javadoc
1 parent e4fa7d0 commit 118705f

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/authc/apikey/CustomTokenAuthenticator.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
import org.elasticsearch.xpack.core.security.authc.AuthenticationToken;
1616

1717
/**
18-
* An extension point to provide a custom API key authenticator implementation.
18+
* An extension point to provide a custom token authenticator implementation. For example, a custom API key or a custom OAuth2 token implementation.
1919
* The implementation is wrapped by a core `Authenticator` class and included in the authenticator chain _before_ the
20-
* default API key authenticator.
20+
* respective "standard" authenticator(s).
2121
*/
2222
public interface CustomTokenAuthenticator {
2323

x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authc/AbstractPluggableAuthenticator.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
/*
2+
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
3+
* or more contributor license agreements. Licensed under the Elastic License
4+
* 2.0; you may not use this file except in compliance with the Elastic License
5+
* 2.0.
6+
*/
7+
18
package org.elasticsearch.xpack.security.authc;
29

310
import org.elasticsearch.action.ActionListener;

x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authc/PluggableOAuth2TokenAuthenticator.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
1+
/*
2+
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
3+
* or more contributor license agreements. Licensed under the Elastic License
4+
* 2.0; you may not use this file except in compliance with the Elastic License
5+
* 2.0.
6+
*/
7+
18
package org.elasticsearch.xpack.security.authc;
29

310
import org.elasticsearch.xpack.core.security.authc.AuthenticationToken;
411
import org.elasticsearch.xpack.core.security.authc.apikey.CustomTokenAuthenticator;
512

13+
/**
14+
* An adapter for {@link CustomTokenAuthenticator} that implements the {@link Authenticator} interface, so the custom API key authenticator
15+
* can be plugged into the authenticator chain. Module dependencies prevent us from introducing a direct extension point for
16+
* an {@link Authenticator}.
17+
*/
618
public class PluggableOAuth2TokenAuthenticator extends AbstractPluggableAuthenticator {
719

820
private CustomTokenAuthenticator customOAuth2TokenAuthenticator;

0 commit comments

Comments
 (0)