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 | |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 34 | import com.google.common.base.Preconditions; |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 35 | |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 36 | import io.grpc.Attributes; |
| 37 | import io.grpc.ClientInterceptor; |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 38 | import io.grpc.LoadBalancer; |
| 39 | import io.grpc.ManagedChannelBuilder; |
| 40 | import io.grpc.NameResolver; |
Kun Zhang | efac679 | 2015-10-22 14:59:44 -0700 | [diff] [blame] | 41 | import io.grpc.NameResolverRegistry; |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 42 | import io.grpc.ResolvedServerInfo; |
| 43 | import io.grpc.SimpleLoadBalancerFactory; |
| 44 | |
| 45 | import java.net.SocketAddress; |
| 46 | import java.net.URI; |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 47 | import java.util.ArrayList; |
| 48 | import java.util.Arrays; |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 49 | import java.util.Collections; |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 50 | import java.util.List; |
Louis Ryan | 6a782a0 | 2015-09-03 14:27:48 -0700 | [diff] [blame] | 51 | import java.util.concurrent.Executor; |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 52 | |
| 53 | import javax.annotation.Nullable; |
| 54 | |
| 55 | /** |
| 56 | * The base class for channel builders. |
nathanmittler | 0304b3d | 2014-10-24 13:39:13 -0700 | [diff] [blame] | 57 | * |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 58 | * @param <T> The concrete type of this builder. |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 59 | */ |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 60 | public abstract class AbstractManagedChannelImplBuilder |
| 61 | <T extends AbstractManagedChannelImplBuilder<T>> extends ManagedChannelBuilder<T> { |
Eric Anderson | aeeebb7 | 2014-12-19 16:41:03 -0800 | [diff] [blame] | 62 | |
ejona | 7235a39 | 2015-01-13 13:38:54 -0800 | [diff] [blame] | 63 | @Nullable |
Louis Ryan | 6a782a0 | 2015-09-03 14:27:48 -0700 | [diff] [blame] | 64 | private Executor executor; |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 65 | private final List<ClientInterceptor> interceptors = new ArrayList<ClientInterceptor>(); |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 66 | |
Kun Zhang | efac679 | 2015-10-22 14:59:44 -0700 | [diff] [blame] | 67 | private final String target; |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 68 | |
| 69 | @Nullable |
| 70 | private final SocketAddress directServerAddress; |
| 71 | |
nmittler | 8c1d38a | 2015-06-01 08:31:00 -0700 | [diff] [blame] | 72 | @Nullable |
| 73 | private String userAgent; |
| 74 | |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 75 | @Nullable |
| 76 | private String authorityOverride; |
| 77 | |
| 78 | @Nullable |
| 79 | private NameResolver.Factory nameResolverFactory; |
| 80 | |
| 81 | @Nullable |
| 82 | private LoadBalancer.Factory loadBalancerFactory; |
| 83 | |
Kun Zhang | efac679 | 2015-10-22 14:59:44 -0700 | [diff] [blame] | 84 | protected AbstractManagedChannelImplBuilder(String target) { |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 85 | this.target = Preconditions.checkNotNull(target); |
| 86 | this.directServerAddress = null; |
| 87 | } |
| 88 | |
| 89 | protected AbstractManagedChannelImplBuilder(SocketAddress directServerAddress, String authority) { |
Kun Zhang | efac679 | 2015-10-22 14:59:44 -0700 | [diff] [blame] | 90 | this.target = "directaddress:///" + directServerAddress; |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 91 | this.directServerAddress = directServerAddress; |
| 92 | this.nameResolverFactory = new DirectAddressNameResolverFactory(directServerAddress, authority); |
| 93 | } |
| 94 | |
Eric Anderson | 6122daf | 2015-09-03 12:14:30 -0700 | [diff] [blame] | 95 | @Override |
Louis Ryan | 6a782a0 | 2015-09-03 14:27:48 -0700 | [diff] [blame] | 96 | public final T executor(Executor executor) { |
nmittler | 777e928 | 2015-08-19 10:01:52 -0700 | [diff] [blame] | 97 | this.executor = executor; |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 98 | return thisT(); |
| 99 | } |
| 100 | |
Eric Anderson | 6122daf | 2015-09-03 12:14:30 -0700 | [diff] [blame] | 101 | @Override |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 102 | public final T intercept(List<ClientInterceptor> interceptors) { |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 103 | this.interceptors.addAll(interceptors); |
| 104 | return thisT(); |
| 105 | } |
| 106 | |
Eric Anderson | 6122daf | 2015-09-03 12:14:30 -0700 | [diff] [blame] | 107 | @Override |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 108 | public final T intercept(ClientInterceptor... interceptors) { |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 109 | return intercept(Arrays.asList(interceptors)); |
| 110 | } |
| 111 | |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 112 | @Override |
| 113 | public final T nameResolverFactory(NameResolver.Factory resolverFactory) { |
| 114 | Preconditions.checkState(directServerAddress == null, |
| 115 | "directServerAddress is set (%s), which forbids the use of NameResolverFactory", |
| 116 | directServerAddress); |
| 117 | this.nameResolverFactory = resolverFactory; |
| 118 | return thisT(); |
| 119 | } |
| 120 | |
| 121 | @Override |
| 122 | public final T loadBalancerFactory(LoadBalancer.Factory loadBalancerFactory) { |
| 123 | Preconditions.checkState(directServerAddress == null, |
| 124 | "directServerAddress is set (%s), which forbids the use of LoadBalancerFactory", |
| 125 | directServerAddress); |
| 126 | this.loadBalancerFactory = loadBalancerFactory; |
| 127 | return thisT(); |
| 128 | } |
| 129 | |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 130 | private T thisT() { |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 131 | @SuppressWarnings("unchecked") |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 132 | T thisT = (T) this; |
Eric Anderson | 0df3d5e | 2015-06-25 18:00:00 -0700 | [diff] [blame] | 133 | return thisT; |
ejona | 7235a39 | 2015-01-13 13:38:54 -0800 | [diff] [blame] | 134 | } |
| 135 | |
Eric Anderson | 6122daf | 2015-09-03 12:14:30 -0700 | [diff] [blame] | 136 | @Override |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 137 | public final T userAgent(String userAgent) { |
nmittler | 8c1d38a | 2015-06-01 08:31:00 -0700 | [diff] [blame] | 138 | this.userAgent = userAgent; |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 139 | return thisT(); |
nmittler | 8c1d38a | 2015-06-01 08:31:00 -0700 | [diff] [blame] | 140 | } |
| 141 | |
Eric Anderson | 6122daf | 2015-09-03 12:14:30 -0700 | [diff] [blame] | 142 | @Override |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 143 | public final T overrideAuthority(String authority) { |
| 144 | this.authorityOverride = checkAuthority(authority); |
| 145 | return thisT(); |
| 146 | } |
| 147 | |
| 148 | /** |
| 149 | * Verifies the authority is valid. This method exists as an escape hatch for putting in an |
| 150 | * authority that is valid, but would fail the default validation provided by this |
| 151 | * implementation. |
| 152 | */ |
| 153 | protected String checkAuthority(String authority) { |
| 154 | return GrpcUtil.checkAuthority(authority); |
| 155 | } |
| 156 | |
| 157 | @Override |
nmittler | b687bdc | 2015-08-31 16:13:39 -0700 | [diff] [blame] | 158 | public ManagedChannelImpl build() { |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 159 | ClientTransportFactory transportFactory = new AuthorityOverridingTransportFactory( |
| 160 | buildTransportFactory(), authorityOverride); |
| 161 | return new ManagedChannelImpl( |
| 162 | target, |
| 163 | // TODO(carl-mastrangelo): Allow clients to pass this in |
| 164 | new ExponentialBackoffPolicy.Provider(), |
Kun Zhang | efac679 | 2015-10-22 14:59:44 -0700 | [diff] [blame] | 165 | nameResolverFactory == null ? NameResolverRegistry.getDefaultRegistry() |
| 166 | : nameResolverFactory, |
Kun Zhang | edd57c9 | 2015-10-27 12:47:29 -0700 | [diff] [blame^] | 167 | getNameResolverParams(), |
Kun Zhang | efac679 | 2015-10-22 14:59:44 -0700 | [diff] [blame] | 168 | loadBalancerFactory == null ? SimpleLoadBalancerFactory.getInstance() |
| 169 | : loadBalancerFactory, |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 170 | transportFactory, executor, userAgent, interceptors); |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | /** |
Kun Zhang | edd57c9 | 2015-10-27 12:47:29 -0700 | [diff] [blame^] | 174 | * Subclasses should override this method to provide the {@link ClientTransportFactory} |
| 175 | * appropriate for this channel. This method is meant for Transport implementors and should not |
| 176 | * be used by normal users. |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 177 | */ |
nmittler | 777e928 | 2015-08-19 10:01:52 -0700 | [diff] [blame] | 178 | protected abstract ClientTransportFactory buildTransportFactory(); |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 179 | |
Kun Zhang | edd57c9 | 2015-10-27 12:47:29 -0700 | [diff] [blame^] | 180 | /** |
| 181 | * Subclasses can override this method to provide additional parameters to {@link |
| 182 | * NameResolver.Factory#newNameResolver}. The default implementation returns {@link |
| 183 | * Attributes.EMPTY}. |
| 184 | */ |
| 185 | protected Attributes getNameResolverParams() { |
| 186 | return Attributes.EMPTY; |
| 187 | } |
| 188 | |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 189 | private static class AuthorityOverridingTransportFactory implements ClientTransportFactory { |
| 190 | final ClientTransportFactory factory; |
| 191 | @Nullable final String authorityOverride; |
| 192 | |
| 193 | AuthorityOverridingTransportFactory( |
| 194 | ClientTransportFactory factory, @Nullable String authorityOverride) { |
| 195 | this.factory = factory; |
| 196 | this.authorityOverride = authorityOverride; |
| 197 | } |
| 198 | |
| 199 | @Override |
| 200 | public ClientTransport newClientTransport(SocketAddress serverAddress, String authority) { |
| 201 | return factory.newClientTransport( |
| 202 | serverAddress, authorityOverride != null ? authorityOverride : authority); |
| 203 | } |
| 204 | |
| 205 | @Override |
| 206 | public int referenceCount() { |
| 207 | return factory.referenceCount(); |
| 208 | } |
| 209 | |
| 210 | @Override |
| 211 | public ReferenceCounted retain() { |
| 212 | factory.retain(); |
| 213 | return this; |
| 214 | } |
| 215 | |
| 216 | @Override |
| 217 | public ReferenceCounted release() { |
| 218 | factory.release(); |
| 219 | return this; |
| 220 | } |
| 221 | } |
| 222 | |
| 223 | private static class DirectAddressNameResolverFactory extends NameResolver.Factory { |
| 224 | final SocketAddress address; |
| 225 | final String authority; |
| 226 | |
| 227 | DirectAddressNameResolverFactory(SocketAddress address, String authority) { |
| 228 | this.address = address; |
| 229 | this.authority = authority; |
| 230 | } |
| 231 | |
| 232 | @Override |
Kun Zhang | edd57c9 | 2015-10-27 12:47:29 -0700 | [diff] [blame^] | 233 | public NameResolver newNameResolver(URI notUsedUri, Attributes params) { |
Kun Zhang | 942f4c9 | 2015-09-04 17:21:44 -0700 | [diff] [blame] | 234 | return new NameResolver() { |
| 235 | @Override |
| 236 | public String getServiceAuthority() { |
| 237 | return authority; |
| 238 | } |
| 239 | |
| 240 | @Override |
| 241 | public void start(final Listener listener) { |
| 242 | listener.onUpdate( |
| 243 | Collections.singletonList(new ResolvedServerInfo(address, Attributes.EMPTY)), |
| 244 | Attributes.EMPTY); |
| 245 | } |
| 246 | |
| 247 | @Override |
| 248 | public void shutdown() {} |
| 249 | }; |
| 250 | } |
| 251 | } |
zhangkun | 8d6d12e | 2014-10-15 13:04:19 -0700 | [diff] [blame] | 252 | } |