com.google.cloud.HttpServiceOptions Maven / Gradle / Ivy
Show all versions of gcloud-java-core Show documentation
/*
* Copyright 2016 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud;
import static com.google.common.base.MoreObjects.firstNonNull;
import com.google.api.client.extensions.appengine.http.UrlFetchTransport;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.cloud.spi.ServiceRpcFactory;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.util.Objects;
/**
* Abstract class representing service options for those services that use HTTP as the transport
* layer.
*
* @param the service subclass
* @param the spi-layer class corresponding to the service
* @param the {@code ServiceOptions} subclass corresponding to the service
*/
public abstract class HttpServiceOptions, ServiceRpcT,
OptionsT extends HttpServiceOptions>
extends ServiceOptions {
private static final long serialVersionUID = 3652819407083815771L;
private final int connectTimeout;
private final int readTimeout;
private final String httpTransportFactoryClassName;
private transient HttpTransportFactory httpTransportFactory;
/**
* A base interface for all {@link HttpTransport} factories.
*
* Implementation must provide a public no-arg constructor. Loading of a factory implementation
* is done via {@link java.util.ServiceLoader}.
*/
public interface HttpTransportFactory {
HttpTransport create();
}
public static class DefaultHttpTransportFactory implements HttpTransportFactory {
private static final HttpTransportFactory INSTANCE = new DefaultHttpTransportFactory();
@Override
public HttpTransport create() {
// Consider App Engine
if (appEngineAppId() != null) {
try {
return new UrlFetchTransport();
} catch (Exception ignore) {
// Maybe not on App Engine
}
}
return new NetHttpTransport();
}
}
/**
* Builder for {@code HttpServiceOptions}.
*
* @param the service subclass
* @param the spi-layer class corresponding to the service
* @param the {@code HttpServiceOptions} subclass corresponding to the service
* @param the {@code ServiceOptions} builder
*/
protected abstract static class Builder, ServiceRpcT,
OptionsT extends HttpServiceOptions,
B extends Builder>
extends ServiceOptions.Builder {
private HttpTransportFactory httpTransportFactory;
private int connectTimeout = -1;
private int readTimeout = -1;
protected Builder() {}
protected Builder(HttpServiceOptions options) {
super(options);
httpTransportFactory = options.httpTransportFactory;
connectTimeout = options.connectTimeout;
readTimeout = options.readTimeout;
}
@Override
protected abstract HttpServiceOptions build();
@SuppressWarnings("unchecked")
protected B self() {
return (B) this;
}
/**
* Sets the HTTP transport factory.
*
* @return the builder
*/
public B httpTransportFactory(HttpTransportFactory httpTransportFactory) {
this.httpTransportFactory = httpTransportFactory;
return self();
}
/**
* Sets the timeout in milliseconds to establish a connection.
*
* @param connectTimeout connection timeout in milliseconds. 0 for an infinite timeout, a
* negative number for the default value (20000).
* @return the builder
*/
public B connectTimeout(int connectTimeout) {
this.connectTimeout = connectTimeout;
return self();
}
/**
* Sets the timeout in milliseconds to read data from an established connection.
*
* @param readTimeout read timeout in milliseconds. 0 for an infinite timeout, a negative number
* for the default value (20000).
* @return the builder
*/
public B readTimeout(int readTimeout) {
this.readTimeout = readTimeout;
return self();
}
}
protected HttpServiceOptions(
Class> serviceFactoryClass,
Class> rpcFactoryClass, Builder builder) {
super(serviceFactoryClass, rpcFactoryClass, builder);
httpTransportFactory = firstNonNull(builder.httpTransportFactory,
getFromServiceLoader(HttpTransportFactory.class, DefaultHttpTransportFactory.INSTANCE));
httpTransportFactoryClassName = httpTransportFactory.getClass().getName();
connectTimeout = builder.connectTimeout;
readTimeout = builder.readTimeout;
}
/**
* Returns the HTTP transport factory.
*/
public HttpTransportFactory httpTransportFactory() {
return httpTransportFactory;
}
/**
* Returns a request initializer responsible for initializing requests according to service
* options.
*/
public HttpRequestInitializer httpRequestInitializer() {
final HttpRequestInitializer delegate =
authCredentials() != null && authCredentials().credentials() != null
? new HttpCredentialsAdapter(authCredentials().credentials().createScoped(scopes()))
: null;
return new HttpRequestInitializer() {
@Override
public void initialize(HttpRequest httpRequest) throws IOException {
if (delegate != null) {
delegate.initialize(httpRequest);
}
if (connectTimeout >= 0) {
httpRequest.setConnectTimeout(connectTimeout);
}
if (readTimeout >= 0) {
httpRequest.setReadTimeout(readTimeout);
}
}
};
}
/**
* Returns the timeout in milliseconds to establish a connection. 0 is an infinite timeout, a
* negative number is the default value (20000).
*/
public int connectTimeout() {
return connectTimeout;
}
/**
* Returns the timeout in milliseconds to read from an established connection. 0 is an infinite
* timeout, a negative number is the default value (20000).
*/
public int readTimeout() {
return readTimeout;
}
@Override
protected int baseHashCode() {
return Objects.hash(super.baseHashCode(), httpTransportFactoryClassName, connectTimeout,
readTimeout);
}
protected boolean baseEquals(HttpServiceOptions other) {
return super.baseEquals(other)
&& Objects.equals(httpTransportFactoryClassName, other.httpTransportFactoryClassName)
&& Objects.equals(connectTimeout, other.connectTimeout)
&& Objects.equals(readTimeout, other.readTimeout);
}
private void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException {
input.defaultReadObject();
httpTransportFactory = newInstance(httpTransportFactoryClassName);
}
}