diff options
author | zpencer <spencerfang@google.com> | 2018-09-04 16:52:01 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-09-04 16:52:01 -0700 |
commit | 4d366ce978683bab49660134a266afff8102fea6 (patch) | |
tree | af13e43aa5b03eafc9616564c244c132ca5ea044 /services | |
parent | f8274c4e7c92733574a16733bc5f725898772f75 (diff) | |
download | grpc-grpc-java-4d366ce978683bab49660134a266afff8102fea6.tar.gz |
all: move Channelz to io.grpc as InternalChannelz (#4797)
This is an API used to coordinate across packages and must live in
`io.grpc`.
Prepending `Internal` makes it easier to detect and hide this class
from public visibility when using certain build tools.
fixes #4796
Diffstat (limited to 'services')
5 files changed, 71 insertions, 69 deletions
diff --git a/services/src/main/java/io/grpc/services/ChannelzProtoUtil.java b/services/src/main/java/io/grpc/services/ChannelzProtoUtil.java index 203b43621..a8acc7d29 100644 --- a/services/src/main/java/io/grpc/services/ChannelzProtoUtil.java +++ b/services/src/main/java/io/grpc/services/ChannelzProtoUtil.java @@ -24,7 +24,18 @@ import com.google.protobuf.Int64Value; import com.google.protobuf.util.Durations; import com.google.protobuf.util.Timestamps; import io.grpc.ConnectivityState; +import io.grpc.Instrumented; +import io.grpc.InternalChannelz; +import io.grpc.InternalChannelz.ChannelStats; +import io.grpc.InternalChannelz.ChannelTrace.Event; +import io.grpc.InternalChannelz.RootChannelList; +import io.grpc.InternalChannelz.ServerList; +import io.grpc.InternalChannelz.ServerSocketsList; +import io.grpc.InternalChannelz.ServerStats; +import io.grpc.InternalChannelz.SocketStats; +import io.grpc.InternalChannelz.TransportStats; import io.grpc.Status; +import io.grpc.WithLogId; import io.grpc.channelz.v1.Address; import io.grpc.channelz.v1.Address.OtherAddress; import io.grpc.channelz.v1.Address.TcpIpAddress; @@ -56,17 +67,6 @@ import io.grpc.channelz.v1.SocketOptionTimeout; import io.grpc.channelz.v1.SocketRef; import io.grpc.channelz.v1.Subchannel; import io.grpc.channelz.v1.SubchannelRef; -import io.grpc.internal.Channelz; -import io.grpc.internal.Channelz.ChannelStats; -import io.grpc.internal.Channelz.ChannelTrace.Event; -import io.grpc.internal.Channelz.RootChannelList; -import io.grpc.internal.Channelz.ServerList; -import io.grpc.internal.Channelz.ServerSocketsList; -import io.grpc.internal.Channelz.ServerStats; -import io.grpc.internal.Channelz.SocketStats; -import io.grpc.internal.Channelz.TransportStats; -import io.grpc.internal.Instrumented; -import io.grpc.internal.WithLogId; import java.net.InetSocketAddress; import java.net.SocketAddress; import java.security.cert.CertificateEncodingException; @@ -142,7 +142,7 @@ final class ChannelzProtoUtil { .build(); } - static Security toSecurity(Channelz.Security security) { + static Security toSecurity(InternalChannelz.Security security) { Preconditions.checkNotNull(security); Preconditions.checkState( security.tls != null ^ security.other != null, @@ -276,7 +276,7 @@ final class ChannelzProtoUtil { .build(); } - static SocketOption toSocketOptionTcpInfo(Channelz.TcpInfo i) { + static SocketOption toSocketOptionTcpInfo(InternalChannelz.TcpInfo i) { SocketOptionTcpInfo tcpInfo = SocketOptionTcpInfo.newBuilder() .setTcpiState(i.state) .setTcpiCaState(i.caState) @@ -321,7 +321,7 @@ final class ChannelzProtoUtil { return SocketOption.newBuilder().setName(name).setValue(value).build(); } - static List<SocketOption> toSocketOptionsList(Channelz.SocketOptions options) { + static List<SocketOption> toSocketOptionsList(InternalChannelz.SocketOptions options) { Preconditions.checkNotNull(options); List<SocketOption> ret = new ArrayList<SocketOption>(); if (options.lingerSeconds != null) { @@ -352,7 +352,7 @@ final class ChannelzProtoUtil { return channelBuilder.build(); } - static ChannelData extractChannelData(Channelz.ChannelStats stats) { + static ChannelData extractChannelData(InternalChannelz.ChannelStats stats) { ChannelData.Builder builder = ChannelData.newBuilder(); builder.setTarget(stats.target) .setState(toChannelConnectivityState(stats.state)) @@ -370,7 +370,7 @@ final class ChannelzProtoUtil { return ChannelConnectivityState.newBuilder().setState(toState(s)).build(); } - private static ChannelTrace toChannelTrace(Channelz.ChannelTrace channelTrace) { + private static ChannelTrace toChannelTrace(InternalChannelz.ChannelTrace channelTrace) { return ChannelTrace.newBuilder() .setNumEventsLogged(channelTrace.numEventsLogged) .setCreationTimestamp(Timestamps.fromNanos(channelTrace.creationTimeNanos)) diff --git a/services/src/main/java/io/grpc/services/ChannelzService.java b/services/src/main/java/io/grpc/services/ChannelzService.java index 5a5e6586a..81415197e 100644 --- a/services/src/main/java/io/grpc/services/ChannelzService.java +++ b/services/src/main/java/io/grpc/services/ChannelzService.java @@ -18,6 +18,12 @@ package io.grpc.services; import com.google.common.annotations.VisibleForTesting; import io.grpc.ExperimentalApi; +import io.grpc.Instrumented; +import io.grpc.InternalChannelz; +import io.grpc.InternalChannelz.ChannelStats; +import io.grpc.InternalChannelz.ServerList; +import io.grpc.InternalChannelz.ServerSocketsList; +import io.grpc.InternalChannelz.SocketStats; import io.grpc.ServerInterceptors; import io.grpc.ServerServiceDefinition; import io.grpc.Status; @@ -34,12 +40,6 @@ import io.grpc.channelz.v1.GetSubchannelRequest; import io.grpc.channelz.v1.GetSubchannelResponse; import io.grpc.channelz.v1.GetTopChannelsRequest; import io.grpc.channelz.v1.GetTopChannelsResponse; -import io.grpc.internal.Channelz; -import io.grpc.internal.Channelz.ChannelStats; -import io.grpc.internal.Channelz.ServerList; -import io.grpc.internal.Channelz.ServerSocketsList; -import io.grpc.internal.Channelz.SocketStats; -import io.grpc.internal.Instrumented; import io.grpc.stub.StreamObserver; /** @@ -47,7 +47,7 @@ import io.grpc.stub.StreamObserver; */ @ExperimentalApi("https://github.com/grpc/grpc-java/issues/4206") public final class ChannelzService extends ChannelzGrpc.ChannelzImplBase { - private final Channelz channelz; + private final InternalChannelz channelz; private final int maxPageSize; /** @@ -56,7 +56,7 @@ public final class ChannelzService extends ChannelzGrpc.ChannelzImplBase { */ @Deprecated public static ChannelzService newInstance(int maxPageSize) { - return new ChannelzService(Channelz.instance(), maxPageSize); + return new ChannelzService(InternalChannelz.instance(), maxPageSize); } /** @@ -67,12 +67,12 @@ public final class ChannelzService extends ChannelzGrpc.ChannelzImplBase { */ public static ServerServiceDefinition createInstance(int maxPageSize) { return ServerInterceptors.intercept( - new ChannelzService(Channelz.instance(), maxPageSize), + new ChannelzService(InternalChannelz.instance(), maxPageSize), new RequireDoubleSubmitCookieInterceptor("grpc-channelz-v1-channelz-token")); } @VisibleForTesting - ChannelzService(Channelz channelz, int maxPageSize) { + ChannelzService(InternalChannelz channelz, int maxPageSize) { this.channelz = channelz; this.maxPageSize = maxPageSize; } @@ -81,7 +81,7 @@ public final class ChannelzService extends ChannelzGrpc.ChannelzImplBase { @Override public void getTopChannels( GetTopChannelsRequest request, StreamObserver<GetTopChannelsResponse> responseObserver) { - Channelz.RootChannelList rootChannels + InternalChannelz.RootChannelList rootChannels = channelz.getRootChannels(request.getStartChannelId(), maxPageSize); responseObserver.onNext(ChannelzProtoUtil.toGetTopChannelResponse(rootChannels)); diff --git a/services/src/test/java/io/grpc/services/ChannelzProtoUtilTest.java b/services/src/test/java/io/grpc/services/ChannelzProtoUtilTest.java index 69dca80c5..9c97beb41 100644 --- a/services/src/test/java/io/grpc/services/ChannelzProtoUtilTest.java +++ b/services/src/test/java/io/grpc/services/ChannelzProtoUtilTest.java @@ -17,7 +17,7 @@ package io.grpc.services; import static com.google.common.truth.Truth.assertThat; -import static io.grpc.internal.Channelz.id; +import static io.grpc.InternalChannelz.id; import static org.junit.Assert.assertEquals; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; @@ -32,6 +32,18 @@ import com.google.protobuf.Message; import com.google.protobuf.util.Durations; import com.google.protobuf.util.Timestamps; import io.grpc.ConnectivityState; +import io.grpc.Instrumented; +import io.grpc.InternalChannelz; +import io.grpc.InternalChannelz.ChannelStats; +import io.grpc.InternalChannelz.ChannelTrace.Event; +import io.grpc.InternalChannelz.ChannelTrace.Event.Severity; +import io.grpc.InternalChannelz.RootChannelList; +import io.grpc.InternalChannelz.ServerList; +import io.grpc.InternalChannelz.ServerSocketsList; +import io.grpc.InternalChannelz.ServerStats; +import io.grpc.InternalChannelz.SocketOptions; +import io.grpc.InternalChannelz.SocketStats; +import io.grpc.WithLogId; import io.grpc.channelz.v1.Address; import io.grpc.channelz.v1.Address.OtherAddress; import io.grpc.channelz.v1.Address.TcpIpAddress; @@ -62,18 +74,6 @@ import io.grpc.channelz.v1.SocketOptionTimeout; import io.grpc.channelz.v1.SocketRef; import io.grpc.channelz.v1.Subchannel; import io.grpc.channelz.v1.SubchannelRef; -import io.grpc.internal.Channelz; -import io.grpc.internal.Channelz.ChannelStats; -import io.grpc.internal.Channelz.ChannelTrace.Event; -import io.grpc.internal.Channelz.ChannelTrace.Event.Severity; -import io.grpc.internal.Channelz.RootChannelList; -import io.grpc.internal.Channelz.ServerList; -import io.grpc.internal.Channelz.ServerSocketsList; -import io.grpc.internal.Channelz.ServerStats; -import io.grpc.internal.Channelz.SocketOptions; -import io.grpc.internal.Channelz.SocketStats; -import io.grpc.internal.Instrumented; -import io.grpc.internal.WithLogId; import io.grpc.services.ChannelzTestHelper.TestChannel; import io.grpc.services.ChannelzTestHelper.TestListenSocket; import io.grpc.services.ChannelzTestHelper.TestServer; @@ -188,8 +188,8 @@ public final class ChannelzProtoUtilTest { .setValue("some-made-up-value") .build(); - private final Channelz.TcpInfo channelzTcpInfo - = new Channelz.TcpInfo.Builder() + private final InternalChannelz.TcpInfo channelzTcpInfo + = new InternalChannelz.TcpInfo.Builder() .setState(70) .setCaState(71) .setRetransmits(72) @@ -440,8 +440,8 @@ public final class ChannelzProtoUtilTest { when(local.getEncoded()).thenReturn("localcert".getBytes(Charsets.UTF_8)); when(remote.getEncoded()).thenReturn("remotecert".getBytes(Charsets.UTF_8)); - socket.security = new Channelz.Security( - new Channelz.Tls("TLS_NULL_WITH_NULL_NULL", local, remote)); + socket.security = new InternalChannelz.Security( + new InternalChannelz.Tls("TLS_NULL_WITH_NULL_NULL", local, remote)); assertEquals( Security.newBuilder().setTls( Tls.newBuilder() @@ -451,8 +451,8 @@ public final class ChannelzProtoUtilTest { .build(), ChannelzProtoUtil.toSocket(socket).getSecurity()); - socket.security = new Channelz.Security( - new Channelz.Tls("TLS_NULL_WITH_NULL_NULL", /*localCert=*/ null, remote)); + socket.security = new InternalChannelz.Security( + new InternalChannelz.Tls("TLS_NULL_WITH_NULL_NULL", /*localCert=*/ null, remote)); assertEquals( Security.newBuilder().setTls( Tls.newBuilder() @@ -461,8 +461,8 @@ public final class ChannelzProtoUtilTest { .build(), ChannelzProtoUtil.toSocket(socket).getSecurity()); - socket.security = new Channelz.Security( - new Channelz.Tls("TLS_NULL_WITH_NULL_NULL", local, /*remoteCert=*/ null)); + socket.security = new InternalChannelz.Security( + new InternalChannelz.Tls("TLS_NULL_WITH_NULL_NULL", local, /*remoteCert=*/ null)); assertEquals( Security.newBuilder().setTls( Tls.newBuilder() @@ -478,7 +478,8 @@ public final class ChannelzProtoUtilTest { Message contents = GetChannelRequest.newBuilder().setChannelId(1).build(); Any packed = Any.pack(contents); socket.security - = new Channelz.Security(new Channelz.OtherSecurity("other_security", packed)); + = new InternalChannelz.Security( + new InternalChannelz.OtherSecurity("other_security", packed)); assertEquals( Security.newBuilder().setOther( OtherSecurity.newBuilder().setName("other_security").setValue(packed)) @@ -808,22 +809,22 @@ public final class ChannelzProtoUtilTest { public void toSocketOptionsList() { assertThat( ChannelzProtoUtil.toSocketOptionsList( - new Channelz.SocketOptions.Builder().build())) + new InternalChannelz.SocketOptions.Builder().build())) .isEmpty(); assertThat( ChannelzProtoUtil.toSocketOptionsList( - new Channelz.SocketOptions.Builder().setSocketOptionLingerSeconds(10).build())) + new InternalChannelz.SocketOptions.Builder().setSocketOptionLingerSeconds(10).build())) .containsExactly(sockOptlinger10s); assertThat( ChannelzProtoUtil.toSocketOptionsList( - new Channelz.SocketOptions.Builder().setSocketOptionTimeoutMillis(200).build())) + new InternalChannelz.SocketOptions.Builder().setSocketOptionTimeoutMillis(200).build())) .containsExactly(sockOptTimeout200ms); assertThat( ChannelzProtoUtil.toSocketOptionsList( - new Channelz.SocketOptions + new InternalChannelz.SocketOptions .Builder() .addOption("SO_MADE_UP_OPTION", "some-made-up-value") .build())) @@ -836,7 +837,7 @@ public final class ChannelzProtoUtilTest { .build(); assertThat( ChannelzProtoUtil.toSocketOptionsList( - new Channelz.SocketOptions.Builder() + new InternalChannelz.SocketOptions.Builder() .addOption("SO_MADE_UP_OPTION", "some-made-up-value") .addOption("SO_MADE_UP_OPTION2", "some-made-up-value2") .build())) @@ -846,7 +847,7 @@ public final class ChannelzProtoUtilTest { @Test public void channelTrace_withoutEvents() { ChannelStats stats = toBuilder(channel.stats) - .setChannelTrace(new Channelz.ChannelTrace.Builder() + .setChannelTrace(new InternalChannelz.ChannelTrace.Builder() .setNumEventsLogged(1234) .setCreationTimeNanos(1000) .build()) @@ -874,7 +875,7 @@ public final class ChannelzProtoUtilTest { ChannelStats stats = toBuilder(channel.stats) .setChannelTrace( - new Channelz.ChannelTrace.Builder() + new InternalChannelz.ChannelTrace.Builder() .setNumEventsLogged(1234) .setCreationTimeNanos(1000) .setEvents(Arrays.asList(event1, event2)) diff --git a/services/src/test/java/io/grpc/services/ChannelzServiceTest.java b/services/src/test/java/io/grpc/services/ChannelzServiceTest.java index b5ebcf432..a8cafdecd 100644 --- a/services/src/test/java/io/grpc/services/ChannelzServiceTest.java +++ b/services/src/test/java/io/grpc/services/ChannelzServiceTest.java @@ -20,6 +20,7 @@ import static org.junit.Assert.assertEquals; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; +import io.grpc.InternalChannelz; import io.grpc.Status; import io.grpc.StatusRuntimeException; import io.grpc.channelz.v1.GetChannelRequest; @@ -32,7 +33,6 @@ import io.grpc.channelz.v1.GetSubchannelRequest; import io.grpc.channelz.v1.GetSubchannelResponse; import io.grpc.channelz.v1.GetTopChannelsRequest; import io.grpc.channelz.v1.GetTopChannelsResponse; -import io.grpc.internal.Channelz; import io.grpc.services.ChannelzTestHelper.TestChannel; import io.grpc.services.ChannelzTestHelper.TestServer; import io.grpc.services.ChannelzTestHelper.TestSocket; @@ -48,7 +48,7 @@ public class ChannelzServiceTest { // small value to force pagination private static final int MAX_PAGE_SIZE = 1; - private final Channelz channelz = new Channelz(); + private final InternalChannelz channelz = new InternalChannelz(); private ChannelzService service = new ChannelzService(channelz, MAX_PAGE_SIZE); @Test diff --git a/services/src/test/java/io/grpc/services/ChannelzTestHelper.java b/services/src/test/java/io/grpc/services/ChannelzTestHelper.java index 072cb18b7..822740056 100644 --- a/services/src/test/java/io/grpc/services/ChannelzTestHelper.java +++ b/services/src/test/java/io/grpc/services/ChannelzTestHelper.java @@ -20,16 +20,16 @@ import com.google.common.base.MoreObjects; import com.google.common.util.concurrent.ListenableFuture; import com.google.common.util.concurrent.SettableFuture; import io.grpc.ConnectivityState; -import io.grpc.internal.Channelz; -import io.grpc.internal.Channelz.ChannelStats; -import io.grpc.internal.Channelz.Security; -import io.grpc.internal.Channelz.ServerStats; -import io.grpc.internal.Channelz.SocketOptions; -import io.grpc.internal.Channelz.SocketStats; -import io.grpc.internal.Channelz.TransportStats; -import io.grpc.internal.Instrumented; -import io.grpc.internal.LogId; -import io.grpc.internal.WithLogId; +import io.grpc.Instrumented; +import io.grpc.InternalChannelz; +import io.grpc.InternalChannelz.ChannelStats; +import io.grpc.InternalChannelz.Security; +import io.grpc.InternalChannelz.ServerStats; +import io.grpc.InternalChannelz.SocketOptions; +import io.grpc.InternalChannelz.SocketStats; +import io.grpc.InternalChannelz.TransportStats; +import io.grpc.LogId; +import io.grpc.WithLogId; import java.net.InetSocketAddress; import java.net.SocketAddress; import java.util.Collections; @@ -57,7 +57,8 @@ final class ChannelzTestHelper { /*remoteFlowControlWindow=*/ 12); SocketAddress local = new InetSocketAddress("10.0.0.1", 1000); SocketAddress remote = new InetSocketAddress("10.0.0.2", 1000); - Channelz.SocketOptions socketOptions = new Channelz.SocketOptions.Builder().build(); + InternalChannelz.SocketOptions socketOptions + = new InternalChannelz.SocketOptions.Builder().build(); Security security = null; @Override |