trait ServerInterceptor extends AnyRef
Cross-cutting logic around gRPC service calls, such as authentication, logging or metrics.
The interceptor runs before the request is unmarshalled. It can reject the call by returning a failed
CompletionStage, for example with a akka.grpc.GrpcServiceException, which is turned into a gRPC error
response using the default exception mapping of GrpcExceptionHandler. It can pass information to a Power API
service implementation by adding request attributes, which are then available through Metadata.getAttribute.
It can also wrap the response to observe the outcome of the call.
The interceptor is called from the server stream and must not block. The request entity is a stream that can
only be consumed once, so an interceptor that reads it must not pass the same request to next.
Errors in streamed responses happen after the response headers are sent and are not visible to interceptors.
- Annotations
- @ApiMayChange() @FunctionalInterface()
- Source
- ServerInterceptor.scala
- Alphabetic
- By Inheritance
- ServerInterceptor
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def intercept(serviceName: String, methodName: String, request: HttpRequest, next: Function[HttpRequest, CompletionStage[HttpResponse]]): CompletionStage[HttpResponse]
- serviceName
the gRPC service name from the request path, without the leading slash
- methodName
the gRPC method name from the request path
- next
the rest of the chain, ending with the service handler
- Annotations
- @throws(classOf[Exception])
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)