grpc
/
grpc-java
mirror of https://github.com/grpc/grpc-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

api: fix LoadBalancer javadoc

This commit is contained in:
ZHANG Dapeng 2021-01-05 13:12:06 -08:00 committed by GitHub
parent 4548cc5632
commit ccef406f89
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
api/src/main/java/io/grpc/LoadBalancer.java
View File

@ -1170,6 +1170,8 @@ public abstract class LoadBalancer {
/** /**
* Returns the authority string of the channel, which is derived from the DNS-style target name. * Returns the authority string of the channel, which is derived from the DNS-style target name.
* If overridden by a load balancer, {@link #getUnsafeChannelCredentials} must also be
* overridden to call {@link #getChannelCredentials} or provide appropriate credentials.
* *
* @since 1.2.0 * @since 1.2.0
*/ */
@ -1185,9 +1187,12 @@ public abstract class LoadBalancer {
} }
/** /**
* Returns the authority string of the channel, which is derived from the DNS-style target name. * Returns the UNSAFE ChannelCredentials used to construct the channel,
* If overridden by a load balancer, {@link #getUnsafeChannelCredentials} must also be * including bearer tokens. Load balancers should generally have no use for
* overridden to call {@link #getChannelCredentials} or provide appropriate credentials. * these credentials and use of them is heavily discouraged. These must be used
* <em>very</em> carefully to avoid sending bearer tokens to untrusted servers
* as the server could then impersonate the client. Generally it is only safe
* to use these credentials when communicating with the backend.
* *
* @since 1.35.0 * @since 1.35.0
*/ */