Class

akka.http.javadsl.server.directives

CodingDirectives

Related Doc: package directives

Permalink

abstract class CodingDirectives extends CacheConditionDirectives

Source
CodingDirectives.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CodingDirectives
  2. CacheConditionDirectives
  3. BasicDirectives
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CodingDirectives()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from CodingDirectives to any2stringadd[CodingDirectives] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CodingDirectives, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from CodingDirectives to ArrowAssoc[CodingDirectives] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def cancelRejection(rejection: Rejection, inner: Supplier[Route]): Route

    Permalink

    Adds a TransformationRejection cancelling all rejections equal to the given one to the list of rejections potentially coming back from the inner route.

    Adds a TransformationRejection cancelling all rejections equal to the given one to the list of rejections potentially coming back from the inner route.

    Definition Classes
    BasicDirectives
  8. def cancelRejections(filter: Predicate[Rejection], inner: Supplier[Route]): Route

    Permalink

    Adds a TransformationRejection cancelling all rejections for which the given filter function returns true to the list of rejections potentially coming back from the inner route.

    Adds a TransformationRejection cancelling all rejections for which the given filter function returns true to the list of rejections potentially coming back from the inner route.

    Definition Classes
    BasicDirectives
  9. def cancelRejections(classes: Iterable[Class[_]], inner: Supplier[Route]): Route

    Permalink

    Adds a TransformationRejection cancelling all rejections of one of the given classes to the list of rejections potentially coming back from the inner route.

    Adds a TransformationRejection cancelling all rejections of one of the given classes to the list of rejections potentially coming back from the inner route.

    Definition Classes
    BasicDirectives
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def conditional(eTag: Optional[EntityTag], lastModified: Optional[DateTime], inner: Supplier[Route]): Route

    Permalink

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

    Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

    Definition Classes
    CacheConditionDirectives
  12. def conditional(eTag: EntityTag, lastModified: DateTime, inner: Supplier[Route]): Route

    Permalink

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

    Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

    Definition Classes
    CacheConditionDirectives
  13. def conditional(lastModified: DateTime, inner: Supplier[Route]): Route

    Permalink

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

    Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

    Definition Classes
    CacheConditionDirectives
  14. def conditional(eTag: EntityTag, inner: Supplier[Route]): Route

    Permalink

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

    In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

    Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

    Definition Classes
    CacheConditionDirectives
  15. def decodeRequest(inner: Supplier[Route]): Route

    Permalink

    Decompresses the incoming request if it is gzip or deflate compressed.

    Decompresses the incoming request if it is gzip or deflate compressed. Uncompressed requests are passed through untouched. If the request encoded with another encoding the request is rejected with an UnsupportedRequestEncodingRejection.

  16. def decodeRequestWith(coders: Iterable[Coder], inner: Supplier[Route]): Route

    Permalink

    Decodes the incoming request if it is encoded with one of the given encoders.

    Decodes the incoming request if it is encoded with one of the given encoders. If the request encoding doesn't match one of the given encoders the request is rejected with an UnsupportedRequestEncodingRejection. If no decoders are given the default encoders (Gzip, Deflate, NoCoding) are used.

  17. def decodeRequestWith(coder: Coder, inner: Supplier[Route]): Route

    Permalink

    Decodes the incoming request using the given Decoder.

    Decodes the incoming request using the given Decoder. If the request encoding doesn't match the request is rejected with an UnsupportedRequestEncodingRejection.

  18. def encodeResponse(inner: Supplier[Route]): Route

    Permalink

    Encodes the response with the encoding that is requested by the client via the Accept- Encoding header.

    Encodes the response with the encoding that is requested by the client via the Accept- Encoding header. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.

    If the Accept-Encoding header is missing or empty or specifies an encoding other than identity, gzip or deflate then no encoding is used.

  19. def encodeResponseWith(coders: Iterable[Coder], inner: Supplier[Route]): Route

    Permalink

    Encodes the response with the encoding that is requested by the client via the Accept- Encoding header.

    Encodes the response with the encoding that is requested by the client via the Accept- Encoding header. The response encoding is determined by the rules specified in http://tools.ietf.org/html/rfc7231#section-5.3.4.

    If the Accept-Encoding header is missing then the response is encoded using the first encoder.

    If the Accept-Encoding header is empty and NoCoding is part of the encoders then no response encoding is used. Otherwise the request is rejected.

    If [encoders] is empty, no encoding is performed.

  20. def ensuring(cond: (CodingDirectives) ⇒ Boolean, msg: ⇒ Any): CodingDirectives

    Permalink
    Implicit information
    This member is added by an implicit conversion from CodingDirectives to Ensuring[CodingDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: (CodingDirectives) ⇒ Boolean): CodingDirectives

    Permalink
    Implicit information
    This member is added by an implicit conversion from CodingDirectives to Ensuring[CodingDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean, msg: ⇒ Any): CodingDirectives

    Permalink
    Implicit information
    This member is added by an implicit conversion from CodingDirectives to Ensuring[CodingDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean): CodingDirectives

    Permalink
    Implicit information
    This member is added by an implicit conversion from CodingDirectives to Ensuring[CodingDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  26. def extract[T](extract: Function[RequestContext, T], inner: Function[T, Route]): Route

    Permalink

    Extracts a single value using the given function.

    Extracts a single value using the given function.

    Definition Classes
    BasicDirectives
  27. def extractActorSystem(inner: Function[ActorSystem, Route]): Route

    Permalink

    Extracts the akka.actor.ActorSystem if the available Materializer is an akka.stream.ActorMaterializer.

    Extracts the akka.actor.ActorSystem if the available Materializer is an akka.stream.ActorMaterializer. Otherwise throws an exception as it won't be able to extract the system from arbitrary materializers.

    Definition Classes
    BasicDirectives
  28. def extractDataBytes(inner: Function[Source[ByteString, Any], Route]): RouteAdapter

    Permalink

    Extracts the entities dataBytes akka.stream.javadsl.Source from the akka.http.javadsl.server.RequestContext.

    Extracts the entities dataBytes akka.stream.javadsl.Source from the akka.http.javadsl.server.RequestContext.

    Definition Classes
    BasicDirectives
  29. def extractEntity(inner: Function[RequestEntity, Route]): Route

    Permalink

    Extracts the current http request entity.

    Extracts the current http request entity.

    Definition Classes
    BasicDirectives
    Annotations
    @CorrespondsTo()
  30. def extractExecutionContext(inner: Function[ExecutionContextExecutor, Route]): Route

    Permalink

    Extracts the ExecutionContextExecutor from the RequestContext.

    Extracts the ExecutionContextExecutor from the RequestContext.

    Definition Classes
    BasicDirectives
  31. def extractLog(inner: Function[LoggingAdapter, Route]): Route

    Permalink

    Extracts the LoggingAdapter

    Extracts the LoggingAdapter

    Definition Classes
    BasicDirectives
  32. def extractMaterializer(inner: Function[Materializer, Route]): Route

    Permalink

    Extracts the Materializer from the RequestContext.

    Extracts the Materializer from the RequestContext.

    Definition Classes
    BasicDirectives
  33. def extractParserSettings(inner: Function[ParserSettings, Route]): RouteAdapter

    Permalink

    Extracts the akka.http.javadsl.settings.ParserSettings from the akka.http.javadsl.server.RequestContext.

    Extracts the akka.http.javadsl.settings.ParserSettings from the akka.http.javadsl.server.RequestContext.

    Definition Classes
    BasicDirectives
  34. def extractRequest(inner: Function[HttpRequest, Route]): RouteAdapter

    Permalink

    Extracts the current HttpRequest instance.

    Extracts the current HttpRequest instance.

    Definition Classes
    BasicDirectives
  35. def extractRequestContext(inner: Function[RequestContext, Route]): RouteAdapter

    Permalink

    Extracts the akka.http.javadsl.server.RequestContext itself.

    Definition Classes
    BasicDirectives
  36. def extractRequestEntity(inner: Function[RequestEntity, Route]): Route

    Permalink

    Extracts the akka.http.javadsl.model.RequestEntity from the akka.http.javadsl.server.RequestContext.

    Extracts the akka.http.javadsl.model.RequestEntity from the akka.http.javadsl.server.RequestContext.

    Definition Classes
    BasicDirectives
  37. def extractSettings(inner: Function[RoutingSettings, Route]): RouteAdapter

    Permalink

    Extracts the RoutingSettings from the akka.http.javadsl.server.RequestContext.

    Extracts the RoutingSettings from the akka.http.javadsl.server.RequestContext.

    Definition Classes
    BasicDirectives
  38. def extractStrictEntity(timeout: FiniteDuration, inner: Function[Strict, Route]): Route

    Permalink

    WARNING: This will read the entire request entity into memory regardless of size and effectively disable streaming.

    WARNING: This will read the entire request entity into memory regardless of size and effectively disable streaming.

    Converts the HttpEntity from the akka.http.javadsl.server.RequestContext into an akka.http.javadsl.model.HttpEntity.Strict and extracts it, or fails the route if unable to drain the entire request body within the timeout.

    timeout

    The directive is failed if the stream isn't completed after the given timeout.

    Definition Classes
    BasicDirectives
  39. def extractUnmatchedPath(inner: Function[String, Route]): RouteAdapter

    Permalink

    Extracts the yet unmatched path from the RequestContext.

    Extracts the yet unmatched path from the RequestContext.

    Definition Classes
    BasicDirectives
  40. def extractUri(inner: Function[Uri, Route]): RouteAdapter

    Permalink

    Extracts the complete request URI.

    Extracts the complete request URI.

    Definition Classes
    BasicDirectives
  41. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  42. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from CodingDirectives to StringFormat[CodingDirectives] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  43. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  44. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  45. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  46. def mapInnerRoute(f: Function[Route, Route], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  47. def mapRejections(f: Function[List[Rejection], List[Rejection]], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  48. def mapRequest(f: Function[HttpRequest, HttpRequest], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  49. def mapRequestContext(f: Function[RequestContext, RequestContext], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  50. def mapResponse(f: Function[HttpResponse, HttpResponse], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  51. def mapResponseEntity(f: Function[ResponseEntity, ResponseEntity], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  52. def mapResponseHeaders(f: Function[List[HttpHeader], List[HttpHeader]], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  53. def mapRouteResult(f: Function[RouteResult, RouteResult], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  54. def mapRouteResultFuture(f: Function[CompletionStage[RouteResult], CompletionStage[RouteResult]], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  55. def mapRouteResultPF(f: PartialFunction[RouteResult, RouteResult], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  56. def mapRouteResultWith(f: Function[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  57. def mapRouteResultWithPF(f: PartialFunction[RouteResult, CompletionStage[RouteResult]], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  58. def mapSettings(f: Function[RoutingSettings, RoutingSettings], inner: Supplier[Route]): Route

    Permalink

    Runs the inner route with settings mapped by the given function.

    Runs the inner route with settings mapped by the given function.

    Definition Classes
    BasicDirectives
  59. def mapUnmatchedPath(f: Function[String, String], inner: Supplier[Route]): Route

    Permalink

    Transforms the unmatchedPath of the RequestContext using the given function.

    Transforms the unmatchedPath of the RequestContext using the given function.

    Definition Classes
    BasicDirectives
  60. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  61. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  62. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  63. def pass(inner: Supplier[Route]): Route

    Permalink

    Always passes the request on to its inner route (i.e.

    Always passes the request on to its inner route (i.e. does nothing with the request or the response).

    Definition Classes
    BasicDirectives
  64. def provide[T](t: T, inner: Function[T, Route]): Route

    Permalink

    Injects the given value into a directive.

    Injects the given value into a directive.

    Definition Classes
    BasicDirectives
  65. def recoverRejections(f: Function[Iterable[Rejection], RouteResult], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  66. def recoverRejectionsWith(f: Function[Iterable[Rejection], CompletionStage[RouteResult]], inner: Supplier[Route]): Route

    Permalink
    Definition Classes
    BasicDirectives
  67. def requestEncodedWith(encoding: HttpEncoding, inner: Supplier[Route]): Route

    Permalink

    Rejects the request with an UnsupportedRequestEncodingRejection if its encoding doesn't match the given one.

  68. def responseEncodingAccepted(encoding: HttpEncoding, inner: Supplier[Route]): Route

    Permalink

    Rejects the request with an UnacceptedResponseEncodingRejection if the given response encoding is not accepted by the client.

  69. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  70. def toStrictEntity(timeout: FiniteDuration, inner: Supplier[Route]): Route

    Permalink

    WARNING: This will read the entire request entity into memory regardless of size and effectively disable streaming.

    WARNING: This will read the entire request entity into memory regardless of size and effectively disable streaming.

    Extracts the akka.http.javadsl.server.RequestContext itself with the strict HTTP entity, or fails the route if unable to drain the entire request body within the timeout.

    timeout

    The directive is failed if the stream isn't completed after the given timeout.

    Definition Classes
    BasicDirectives
  71. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  72. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  73. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. def withExecutionContext(ec: ExecutionContextExecutor, inner: Supplier[Route]): Route

    Permalink

    Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.

    Runs its inner route with the given alternative scala.concurrent.ExecutionContextExecutor.

    Definition Classes
    BasicDirectives
  76. def withLog(log: LoggingAdapter, inner: Supplier[Route]): Route

    Permalink

    Runs its inner route with the given alternative LoggingAdapter.

    Runs its inner route with the given alternative LoggingAdapter.

    Definition Classes
    BasicDirectives
  77. def withMaterializer(mat: Materializer, inner: Supplier[Route]): Route

    Permalink

    Runs its inner route with the given alternative akka.stream.Materializer.

    Runs its inner route with the given alternative akka.stream.Materializer.

    Definition Classes
    BasicDirectives
  78. def withPrecompressedMediaTypeSupport(inner: Supplier[Route]): Route

    Permalink

    Inspects the response entity and adds a Content-Encoding: gzip response header if the entities media-type is precompressed with gzip and no Content-Encoding header is present yet.

  79. def withSettings(s: RoutingSettings, inner: Supplier[Route]): Route

    Permalink

    Runs its inner route with the given alternative RoutingSettings.

    Runs its inner route with the given alternative RoutingSettings.

    Definition Classes
    BasicDirectives
  80. def [B](y: B): (CodingDirectives, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from CodingDirectives to ArrowAssoc[CodingDirectives] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from CacheConditionDirectives

Inherited from BasicDirectives

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CodingDirectives to any2stringadd[CodingDirectives]

Inherited by implicit conversion StringFormat from CodingDirectives to StringFormat[CodingDirectives]

Inherited by implicit conversion Ensuring from CodingDirectives to Ensuring[CodingDirectives]

Inherited by implicit conversion ArrowAssoc from CodingDirectives to ArrowAssoc[CodingDirectives]

Ungrouped