lryan | 56e307f | 2014-12-05 13:25:08 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014, Google Inc. All rights reserved. |
| 3 | * |
| 4 | * Redistribution and use in source and binary forms, with or without |
| 5 | * modification, are permitted provided that the following conditions are |
| 6 | * met: |
| 7 | * |
| 8 | * * Redistributions of source code must retain the above copyright |
| 9 | * notice, this list of conditions and the following disclaimer. |
| 10 | * * Redistributions in binary form must reproduce the above |
| 11 | * copyright notice, this list of conditions and the following disclaimer |
| 12 | * in the documentation and/or other materials provided with the |
| 13 | * distribution. |
| 14 | * |
| 15 | * * Neither the name of Google Inc. nor the names of its |
| 16 | * contributors may be used to endorse or promote products derived from |
| 17 | * this software without specific prior written permission. |
| 18 | * |
| 19 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 20 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 21 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 22 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 23 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 24 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 25 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 26 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 27 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 28 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 29 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 30 | */ |
| 31 | |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 32 | package io.grpc.internal; |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 33 | |
Carl Mastrangelo | 82a79d8 | 2015-12-07 14:40:11 -0800 | [diff] [blame] | 34 | import static com.google.common.base.MoreObjects.firstNonNull; |
| 35 | |
Kun Zhang | 631a9d5 | 2016-06-02 16:47:36 -0700 | [diff] [blame^] | 36 | import com.google.common.annotations.VisibleForTesting; |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 37 | import com.google.common.base.Preconditions; |
buchgr | 602473d | 2015-11-11 12:53:08 +0100 | [diff] [blame] | 38 | import com.google.common.util.concurrent.MoreExecutors; |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 39 | |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 40 | import io.grpc.Attributes; |
| 41 | import io.grpc.ClientInterceptor; |
Carl Mastrangelo | 82a79d8 | 2015-12-07 14:40:11 -0800 | [diff] [blame] | 42 | import io.grpc.CompressorRegistry; |
| 43 | import io.grpc.DecompressorRegistry; |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 44 | import io.grpc.LoadBalancer; |
| 45 | import io.grpc.ManagedChannelBuilder; |
| 46 | import io.grpc.NameResolver; |
Kun Zhang | efac679 | 2015-10-22 14:59:44 -0700 | [diff] [blame] | 47 | import io.grpc.NameResolverRegistry; |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 48 | import io.grpc.ResolvedServerInfo; |
| 49 | import io.grpc.SimpleLoadBalancerFactory; |
| 50 | |
| 51 | import java.net.SocketAddress; |
| 52 | import java.net.URI; |
Kun Zhang | 631a9d5 | 2016-06-02 16:47:36 -0700 | [diff] [blame^] | 53 | import java.net.URISyntaxException; |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 54 | import java.util.ArrayList; |
| 55 | import java.util.Arrays; |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 56 | import java.util.Collections; |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 57 | import java.util.List; |
Louis Ryan | 6a782a0 | 2015-09-03 14:27:48 -0700 | [diff] [blame] | 58 | import java.util.concurrent.Executor; |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 59 | |
| 60 | import javax.annotation.Nullable; |
| 61 | |
| 62 | /** |
| 63 | * The base class for channel builders. |
nathanmittler | 0304b3d | 2014-10-24 13:39:13 -0700 | [diff] [blame] | 64 | * |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 65 | * @param <T> The concrete type of this builder. |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 66 | */ |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 67 | public abstract class AbstractManagedChannelImplBuilder |
| 68 | <T extends AbstractManagedChannelImplBuilder<T>> extends ManagedChannelBuilder<T> { |
Kun Zhang | 1624715 | 2015-12-08 17:52:05 -0800 | [diff] [blame] | 69 | private static final String DIRECT_ADDRESS_SCHEME = "directaddress"; |
Eric Anderson | aeeebb7 | 2014-12-19 16:41:03 -0800 | [diff] [blame] | 70 | |
ejona | 7235a39 | 2015-01-13 13:38:54 -0800 | [diff] [blame] | 71 | @Nullable |
Louis Ryan | 6a782a0 | 2015-09-03 14:27:48 -0700 | [diff] [blame] | 72 | private Executor executor; |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 73 | private final List<ClientInterceptor> interceptors = new ArrayList<ClientInterceptor>(); |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 74 | |
Kun Zhang | efac679 | 2015-10-22 14:59:44 -0700 | [diff] [blame] | 75 | private final String target; |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 76 | |
| 77 | @Nullable |
| 78 | private final SocketAddress directServerAddress; |
| 79 | |
nmittler | 8c1d38a | 2015-06-01 08:31:00 -0700 | [diff] [blame] | 80 | @Nullable |
| 81 | private String userAgent; |
| 82 | |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 83 | @Nullable |
| 84 | private String authorityOverride; |
| 85 | |
| 86 | @Nullable |
| 87 | private NameResolver.Factory nameResolverFactory; |
| 88 | |
| 89 | @Nullable |
| 90 | private LoadBalancer.Factory loadBalancerFactory; |
| 91 | |
Carl Mastrangelo | 82a79d8 | 2015-12-07 14:40:11 -0800 | [diff] [blame] | 92 | @Nullable |
| 93 | private DecompressorRegistry decompressorRegistry; |
| 94 | |
| 95 | @Nullable |
| 96 | private CompressorRegistry compressorRegistry; |
| 97 | |
Kun Zhang | efac679 | 2015-10-22 14:59:44 -0700 | [diff] [blame] | 98 | protected AbstractManagedChannelImplBuilder(String target) { |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 99 | this.target = Preconditions.checkNotNull(target); |
| 100 | this.directServerAddress = null; |
| 101 | } |
| 102 | |
Kun Zhang | 631a9d5 | 2016-06-02 16:47:36 -0700 | [diff] [blame^] | 103 | /** |
| 104 | * Returns a target string for the SocketAddress. It is only used as a placeholder, because |
| 105 | * DirectAddressNameResolverFactory will not actually try to use it. However, it must be a valid |
| 106 | * URI. |
| 107 | */ |
| 108 | @VisibleForTesting |
| 109 | static String makeTargetStringForDirectAddress(SocketAddress address) { |
| 110 | try { |
| 111 | return new URI(DIRECT_ADDRESS_SCHEME, "", "/" + address, null).toString(); |
| 112 | } catch (URISyntaxException e) { |
| 113 | // It should not happen. |
| 114 | throw new RuntimeException(e); |
| 115 | } |
| 116 | } |
| 117 | |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 118 | protected AbstractManagedChannelImplBuilder(SocketAddress directServerAddress, String authority) { |
Kun Zhang | 631a9d5 | 2016-06-02 16:47:36 -0700 | [diff] [blame^] | 119 | this.target = makeTargetStringForDirectAddress(directServerAddress); |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 120 | this.directServerAddress = directServerAddress; |
| 121 | this.nameResolverFactory = new DirectAddressNameResolverFactory(directServerAddress, authority); |
| 122 | } |
| 123 | |
Eric Anderson | 6122daf | 2015-09-03 12:14:30 -0700 | [diff] [blame] | 124 | @Override |
buchgr | 602473d | 2015-11-11 12:53:08 +0100 | [diff] [blame] | 125 | public final T directExecutor() { |
| 126 | return executor(MoreExecutors.directExecutor()); |
| 127 | } |
| 128 | |
| 129 | @Override |
Louis Ryan | 6a782a0 | 2015-09-03 14:27:48 -0700 | [diff] [blame] | 130 | public final T executor(Executor executor) { |
nmittler | 777e928 | 2015-08-19 10:01:52 -0700 | [diff] [blame] | 131 | this.executor = executor; |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 132 | return thisT(); |
| 133 | } |
| 134 | |
Eric Anderson | 6122daf | 2015-09-03 12:14:30 -0700 | [diff] [blame] | 135 | @Override |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 136 | public final T intercept(List<ClientInterceptor> interceptors) { |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 137 | this.interceptors.addAll(interceptors); |
| 138 | return thisT(); |
| 139 | } |
| 140 | |
Eric Anderson | 6122daf | 2015-09-03 12:14:30 -0700 | [diff] [blame] | 141 | @Override |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 142 | public final T intercept(ClientInterceptor... interceptors) { |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 143 | return intercept(Arrays.asList(interceptors)); |
| 144 | } |
| 145 | |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 146 | @Override |
| 147 | public final T nameResolverFactory(NameResolver.Factory resolverFactory) { |
| 148 | Preconditions.checkState(directServerAddress == null, |
| 149 | "directServerAddress is set (%s), which forbids the use of NameResolverFactory", |
| 150 | directServerAddress); |
| 151 | this.nameResolverFactory = resolverFactory; |
| 152 | return thisT(); |
| 153 | } |
| 154 | |
| 155 | @Override |
| 156 | public final T loadBalancerFactory(LoadBalancer.Factory loadBalancerFactory) { |
| 157 | Preconditions.checkState(directServerAddress == null, |
| 158 | "directServerAddress is set (%s), which forbids the use of LoadBalancerFactory", |
| 159 | directServerAddress); |
| 160 | this.loadBalancerFactory = loadBalancerFactory; |
| 161 | return thisT(); |
| 162 | } |
| 163 | |
Carl Mastrangelo | 82a79d8 | 2015-12-07 14:40:11 -0800 | [diff] [blame] | 164 | @Override |
Carl Mastrangelo | 82a79d8 | 2015-12-07 14:40:11 -0800 | [diff] [blame] | 165 | public final T decompressorRegistry(DecompressorRegistry registry) { |
| 166 | this.decompressorRegistry = registry; |
| 167 | return thisT(); |
| 168 | } |
| 169 | |
| 170 | @Override |
Carl Mastrangelo | 82a79d8 | 2015-12-07 14:40:11 -0800 | [diff] [blame] | 171 | public final T compressorRegistry(CompressorRegistry registry) { |
| 172 | this.compressorRegistry = registry; |
| 173 | return thisT(); |
| 174 | } |
| 175 | |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 176 | private T thisT() { |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 177 | @SuppressWarnings("unchecked") |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 178 | T thisT = (T) this; |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 179 | return thisT; |
ejona | 7235a39 | 2015-01-13 13:38:54 -0800 | [diff] [blame] | 180 | } |
| 181 | |
Eric Anderson | 6122daf | 2015-09-03 12:14:30 -0700 | [diff] [blame] | 182 | @Override |
Carl Mastrangelo | 1cc76d8 | 2016-05-24 16:29:26 -0700 | [diff] [blame] | 183 | public final T userAgent(@Nullable String userAgent) { |
nmittler | 8c1d38a | 2015-06-01 08:31:00 -0700 | [diff] [blame] | 184 | this.userAgent = userAgent; |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 185 | return thisT(); |
nmittler | 8c1d38a | 2015-06-01 08:31:00 -0700 | [diff] [blame] | 186 | } |
| 187 | |
Eric Anderson | 6122daf | 2015-09-03 12:14:30 -0700 | [diff] [blame] | 188 | @Override |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 189 | public final T overrideAuthority(String authority) { |
| 190 | this.authorityOverride = checkAuthority(authority); |
| 191 | return thisT(); |
| 192 | } |
| 193 | |
| 194 | /** |
| 195 | * Verifies the authority is valid. This method exists as an escape hatch for putting in an |
| 196 | * authority that is valid, but would fail the default validation provided by this |
| 197 | * implementation. |
| 198 | */ |
| 199 | protected String checkAuthority(String authority) { |
| 200 | return GrpcUtil.checkAuthority(authority); |
| 201 | } |
| 202 | |
| 203 | @Override |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 204 | public ManagedChannelImpl build() { |
Sky Ao | 1d8aefa | 2016-04-18 23:43:30 +0800 | [diff] [blame] | 205 | ClientTransportFactory transportFactory = buildTransportFactory(); |
| 206 | if (authorityOverride != null) { |
| 207 | transportFactory = new AuthorityOverridingTransportFactory( |
| 208 | transportFactory, authorityOverride); |
| 209 | } |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 210 | return new ManagedChannelImpl( |
| 211 | target, |
Eric Anderson | a40b686 | 2016-03-25 10:23:58 -0700 | [diff] [blame] | 212 | // TODO(carl-mastrangelo): Allow clients to pass this in |
| 213 | new ExponentialBackoffPolicy.Provider(), |
Carl Mastrangelo | 82a79d8 | 2015-12-07 14:40:11 -0800 | [diff] [blame] | 214 | firstNonNull(nameResolverFactory, NameResolverRegistry.getDefaultRegistry()), |
Kun Zhang | edd57c9 | 2015-10-27 12:47:29 -0700 | [diff] [blame] | 215 | getNameResolverParams(), |
Carl Mastrangelo | 82a79d8 | 2015-12-07 14:40:11 -0800 | [diff] [blame] | 216 | firstNonNull(loadBalancerFactory, SimpleLoadBalancerFactory.getInstance()), |
| 217 | transportFactory, |
| 218 | firstNonNull(decompressorRegistry, DecompressorRegistry.getDefaultInstance()), |
| 219 | firstNonNull(compressorRegistry, CompressorRegistry.getDefaultInstance()), |
| 220 | executor, userAgent, interceptors); |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 221 | } |
| 222 | |
| 223 | /** |
Kun Zhang | edd57c9 | 2015-10-27 12:47:29 -0700 | [diff] [blame] | 224 | * Subclasses should override this method to provide the {@link ClientTransportFactory} |
| 225 | * appropriate for this channel. This method is meant for Transport implementors and should not |
| 226 | * be used by normal users. |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 227 | */ |
nmittler | 777e928 | 2015-08-19 10:01:52 -0700 | [diff] [blame] | 228 | protected abstract ClientTransportFactory buildTransportFactory(); |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 229 | |
Kun Zhang | edd57c9 | 2015-10-27 12:47:29 -0700 | [diff] [blame] | 230 | /** |
| 231 | * Subclasses can override this method to provide additional parameters to {@link |
| 232 | * NameResolver.Factory#newNameResolver}. The default implementation returns {@link |
Carl Mastrangelo | 82a79d8 | 2015-12-07 14:40:11 -0800 | [diff] [blame] | 233 | * Attributes#EMPTY}. |
Kun Zhang | edd57c9 | 2015-10-27 12:47:29 -0700 | [diff] [blame] | 234 | */ |
| 235 | protected Attributes getNameResolverParams() { |
| 236 | return Attributes.EMPTY; |
| 237 | } |
| 238 | |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 239 | private static class AuthorityOverridingTransportFactory implements ClientTransportFactory { |
| 240 | final ClientTransportFactory factory; |
Sky Ao | 1d8aefa | 2016-04-18 23:43:30 +0800 | [diff] [blame] | 241 | final String authorityOverride; |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 242 | |
| 243 | AuthorityOverridingTransportFactory( |
Sky Ao | 1d8aefa | 2016-04-18 23:43:30 +0800 | [diff] [blame] | 244 | ClientTransportFactory factory, String authorityOverride) { |
| 245 | this.factory = Preconditions.checkNotNull(factory, "factory should not be null"); |
| 246 | this.authorityOverride = Preconditions.checkNotNull( |
| 247 | authorityOverride, "authorityOverride should not be null"); |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 248 | } |
| 249 | |
| 250 | @Override |
Kun Zhang | cf787bd | 2016-01-29 17:25:42 -0800 | [diff] [blame] | 251 | public ManagedClientTransport newClientTransport(SocketAddress serverAddress, |
Carl Mastrangelo | 1cc76d8 | 2016-05-24 16:29:26 -0700 | [diff] [blame] | 252 | String authority, @Nullable String userAgent) { |
| 253 | return factory.newClientTransport(serverAddress, authorityOverride, userAgent); |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 254 | } |
| 255 | |
| 256 | @Override |
buchgr | 3c68c05 | 2016-03-17 00:14:43 +0100 | [diff] [blame] | 257 | public void close() { |
| 258 | factory.close(); |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 259 | } |
| 260 | } |
| 261 | |
| 262 | private static class DirectAddressNameResolverFactory extends NameResolver.Factory { |
| 263 | final SocketAddress address; |
| 264 | final String authority; |
| 265 | |
| 266 | DirectAddressNameResolverFactory(SocketAddress address, String authority) { |
| 267 | this.address = address; |
| 268 | this.authority = authority; |
| 269 | } |
| 270 | |
| 271 | @Override |
Kun Zhang | edd57c9 | 2015-10-27 12:47:29 -0700 | [diff] [blame] | 272 | public NameResolver newNameResolver(URI notUsedUri, Attributes params) { |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 273 | return new NameResolver() { |
| 274 | @Override |
| 275 | public String getServiceAuthority() { |
| 276 | return authority; |
| 277 | } |
| 278 | |
| 279 | @Override |
| 280 | public void start(final Listener listener) { |
| 281 | listener.onUpdate( |
| 282 | Collections.singletonList(new ResolvedServerInfo(address, Attributes.EMPTY)), |
| 283 | Attributes.EMPTY); |
| 284 | } |
| 285 | |
| 286 | @Override |
| 287 | public void shutdown() {} |
| 288 | }; |
| 289 | } |
Kun Zhang | 1624715 | 2015-12-08 17:52:05 -0800 | [diff] [blame] | 290 | |
| 291 | @Override |
| 292 | public String getDefaultScheme() { |
| 293 | return DIRECT_ADDRESS_SCHEME; |
| 294 | } |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 295 | } |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 296 | } |