Package io.grpc.alts

Class AltsChannelBuilder

  • @ExperimentalApi("https://github.com/grpc/grpc-java/issues/4151")
public final class AltsChannelBuilder
extends io.grpc.ForwardingChannelBuilder2<AltsChannelBuilder>
    ALTS version of ManagedChannelBuilder. This class sets up a secure and authenticated communication between two cloud VMs using ALTS.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class io.grpc.ManagedChannelBuilder

        io.grpc.ManagedChannelBuilder.InterceptorFactory

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private AltsChannelBuilder​(java.lang.String target)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AltsChannelBuilder addTargetServiceAccount​(java.lang.String targetServiceAccount)
      Adds an expected target service accounts.
      io.grpc.ManagedChannel build()  
      protected io.grpc.netty.NettyChannelBuilder delegate()  
      AltsChannelBuilder enableUntrustedAltsForTesting()
      Enables untrusted ALTS for testing.
      static AltsChannelBuilder forAddress​(java.lang.String name, int port)
      "Overrides" the static method in ManagedChannelBuilder.
      static AltsChannelBuilder forTarget​(java.lang.String target)
      "Overrides" the static method in ManagedChannelBuilder.
      (package private) io.grpc.netty.InternalProtocolNegotiator.ProtocolNegotiator getProtocolNegotiatorForTest()  
      AltsChannelBuilder setHandshakerAddressForTesting​(java.lang.String handshakerAddress)
      Sets a new handshaker service address for testing.

      • Methods inherited from class io.grpc.ForwardingChannelBuilder2

        addMetricSink, addTransportFilter, compressorRegistry, decompressorRegistry, defaultLoadBalancingPolicy, defaultServiceConfig, directExecutor, disableRetry, disableServiceConfigLookUp, enableRetry, executor, idleTimeout, intercept, intercept, interceptWithTarget, keepAliveTime, keepAliveTimeout, keepAliveWithoutCalls, maxHedgedAttempts, maxInboundMessageSize, maxInboundMetadataSize, maxRetryAttempts, maxTraceEvents, nameResolverFactory, offloadExecutor, overrideAuthority, perRpcBufferLimit, proxyDetector, retryBufferSize, setBinaryLog, toString, usePlaintext, userAgent, useTransportSecurity

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • delegate

        private final io.grpc.netty.NettyChannelBuilder delegate

    • Constructor Detail

      • AltsChannelBuilder

        private AltsChannelBuilder​(java.lang.String target)

    • Method Detail

      • forTarget

        public static AltsChannelBuilder forTarget​(java.lang.String target)
        "Overrides" the static method in ManagedChannelBuilder.

      • forAddress

        public static AltsChannelBuilder forAddress​(java.lang.String name,
                                            int port)
        "Overrides" the static method in ManagedChannelBuilder.

      • addTargetServiceAccount

        public AltsChannelBuilder addTargetServiceAccount​(java.lang.String targetServiceAccount)
        Adds an expected target service accounts. One of the added service accounts should match peer service account in the handshaker result. Otherwise, the handshake fails.

      • enableUntrustedAltsForTesting

        public AltsChannelBuilder enableUntrustedAltsForTesting()
        Enables untrusted ALTS for testing. If this function is called, we will not check whether ALTS is running on Google Cloud Platform.

      • setHandshakerAddressForTesting

        public AltsChannelBuilder setHandshakerAddressForTesting​(java.lang.String handshakerAddress)
        Sets a new handshaker service address for testing.

      • delegate

        protected io.grpc.netty.NettyChannelBuilder delegate()
        Specified by:
        delegate in class io.grpc.ForwardingChannelBuilder2<AltsChannelBuilder>

      • build

        public io.grpc.ManagedChannel build()
        Overrides:
        build in class io.grpc.ForwardingChannelBuilder2<AltsChannelBuilder>

      • getProtocolNegotiatorForTest

        @Nullable
io.grpc.netty.InternalProtocolNegotiator.ProtocolNegotiator getProtocolNegotiatorForTest()