• Getting Started
• Documentation
  • spray-caching
    • Dependencies
    • Installation
    • The Cache Interface
    • Example
    • Cache Implementations
      • SimpleLruCache
      • ExpiringLruCache
  • spray-can
    • Dependencies
    • Installation
    • Configuration
    • HTTP Server
      • Design Philosophy
      • Basic Architecture
      • Starting
      • Stopping
      • Message Protocol
        • Request-Response Cycle
        • Chunked Requests
        • Chunked Responses
        • Request Timeouts
        • Closed Notifications
        • Server Statistics
      • HTTP Headers
      • HTTP Pipelining
      • SSL Support
    • HTTP Client APIs
      • Connection-level API
        • Opening HTTP Connections
        • Request-Response Cycle
        • Closing Connections
        • Timeouts
      • Host-level API
        • Starting an HttpHostConnector
        • Using an HttpHostConnector
        • Retrying a Request
        • Connector Shutdown
      • Request-level API
      • Basic API Structure
      • Chunked Requests
      • Chunked Responses
      • HTTP Headers
      • SSL Support
      • Redirection Following
        • Which redirects are followed?
    • Common Behavior
      • Closing Connections
      • ACKed Sends
    • Examples
      • simple-http-client
      • simple-http-server
      • server-benchmark
  • spray-client
    • Dependencies
    • Installation
    • Usage
    • Example
      • simple-spray-client
  • spray-http
    • Dependencies
    • Installation
    • Overview
    • Content-Type Header
    • Custom Media-Types
  • spray-httpx
    • Dependencies
    • Installation
    • Marshalling
      • Default Marshallers
      • Implicit Resolution
      • Custom Marshallers
      • Deriving Marshallers
      • ToResponseMarshaller
    • Unmarshalling
      • Default Unmarshallers
      • Implicit Resolution
      • Custom Unmarshallers
      • Deriving Unmarshallers
        • Unmarshaller.delegate
        • Unmarshaller.forNonEmpty
      • More specific Unmarshallers
        • FromMessageUnmarshaller
        • FromRequestUnmarshaller
        • FromResponseUnmarshaller
    • (De)compression
      • Compression of Chunk Streams
    • Request Building
    • Response Transformation
      • Predefined Response Transformers
    • spray-json Support
    • lift-json Support
    • json4s Support
    • Twirl Support
  • spray-io
  • spray-routing
    • Dependencies
    • Installation
    • Configuration
    • Getting Started
      • SimpleRoutingApp
    • Key Concepts
      • Big Picture
        • The HttpService
        • The runRoute Wrapper
      • Routes
        • Constructing Routes
        • Composing Routes
        • The Routing Tree
      • Directives
        • What Directives do
        • The Responder Chain
        • Composing Directives
        • Type Safety
      • Rejections
        • Predefined Rejections
        • RejectionHandler
        • Rejection Cancellation
        • Empty Rejections
      • Exception Handling
      • Timeout Handling
    • Advanced Topics
      • Understanding the DSL Structure
        • Understanding Extractions
        • Performance Tuning
      • Case Class Extraction
        • Case Class Validation
      • Custom Directives
        • Configuration Labelling
        • Transforming Directives
          • map / hmap
          • flatMap / hflatMap
          • require / hrequire
          • recover / recoverPF
        • Directives from Scratch
      • Response Streaming
    • Predefined Directives (alphabetically)
    • Predefined Directives (by trait)
      • Directives filtering or extracting from the request
      • Directives creating or transforming the response
      • List of predefined directives by trait
        • AnyParamDirectives
          • anyParam
            • Signature
            • Description
          • anyParams
            • Signature
            • Description
            • Example
        • BasicDirectives
          • Directives to provide values to inner routes
          • Directives transforming the request
          • Directives transforming the response
          • Directives hooking into the responder chain
          • Directives changing the execution of the inner route
          • Directives alphabetically
            • extract
              • Signature
              • Description
              • Example
            • hextract
              • Signature
              • Description
              • Example
            • hprovide
              • Signature
              • Description
              • Example
            • mapHttpResponse
              • Signature
              • Description
              • Example
            • mapHttpResponseEntity
              • Signature
              • Description
              • Example
            • mapHttpResponseHeaders
              • Signature
              • Description
              • Example
            • mapHttpResponsePart
              • Signature
              • Description
              • Example
            • mapInnerRoute
              • Signature
              • Description
              • Example
            • mapRejections
              • Signature
              • Description
              • Example
            • mapRequest
              • Signature
              • Description
              • Example
            • mapRequestContext
              • Signature
              • Description
              • Example
            • mapRouteResponse
              • Signature
              • Description
              • Example
            • mapRouteResponsePF
              • Signature
              • Description
              • Example
            • noop
              • Signature
              • Description
              • Example
            • pass
            • provide
              • Signature
              • Description
              • Example
            • routeRouteResponse
              • Signature
              • Description
              • Example
        • CacheConditionDirectives
          • conditional
            • Signature
            • Description
        • CachingDirectives
          • alwaysCache
            • Signature
            • Description
            • Example
          • cache
            • Signature
            • Description
            • Example
          • cachingProhibited
            • Signature
            • Description
            • Example
          • Usage
        • ChunkingDirectives
          • autoChunk
            • Signature
            • Description
            • Example
          • autoChunkFileBytes
            • Signature
            • Description
            • Example
        • CookieDirectives
          • cookie
            • Signature
            • Description
            • Example
          • deleteCookie
            • Signature
            • Description
            • Example
          • optionalCookie
            • Signature
            • Description
            • Example
          • setCookie
            • Signature
            • Description
            • Example
        • DebuggingDirectives
          • logRequest
            • Signature
            • Description
            • Example
          • logRequestResponse
            • Signature
            • Description
            • Example
          • logResponse
            • Signature
            • Description
            • Example
        • EncodingDirectives
          • compressResponse
            • Signature
            • Description
            • Example
          • compressResponseIfRequested
            • Signature
            • Description
            • Example
          • decodeRequest
            • Signature
            • Description
            • Example
          • decompressRequest
            • Signature
            • Description
            • Example
          • encodeResponse
            • Signature
            • Description
            • Example
          • requestEncodedWith
            • Signature
            • Description
          • responseEncodingAccepted
            • Signature
            • Description
          • When to use which compression directive?
          • When to use which decompression directive?
          • Combining compression and decompression
        • ExecutionDirectives
          • detach
            • Signature
            • Description
            • Example
          • dynamic
            • Signature
            • Description
            • Example
          • dynamicIf
            • Signature
            • Description
            • Example
          • handleExceptions
            • Signature
            • Description
            • Example
          • handleRejections
            • Signature
            • Description
            • Example
        • FileAndResourceDirectives
          • getFromBrowseableDirectory
            • Signature
          • getFromBrowseableDirectories
            • Signature
            • Description
          • getFromDirectory
            • Signature
            • Description
          • getFromFile
            • Signature
            • Description
          • getFromResource
            • Signature
            • Description
          • getFromResourceDirectory
            • Signature
            • Description
          • listDirectoryContents
            • Signature
            • Description
          • respondWithLastModifiedHeader
            • Signature
        • FormFieldDirectives
          • formField
            • Signature
            • Description
          • formFields
            • Signature
            • Description
            • Unmarshalling
              • Details
            • Example
        • FuturesDirectives
          • onComplete
            • Signature
            • Description
            • Example
          • onSuccess
            • Signature
            • Description
            • Example
          • onFailure
            • Signature
            • Description
            • Example
        • HeaderDirectives
          • headerValue
            • Signature
            • Description
            • Example
          • headerValueByName
            • Signature
            • Description
            • Example
          • headerValueByType
            • Signature
            • Description
            • Example
          • headerValuePF
            • Signature
            • Description
            • Example
          • optionalHeaderValue
            • Signature
            • Description
          • optionalHeaderValueByName
            • Signature
            • Description
          • optionalHeaderValueByType
            • Signature
            • Description
            • Example
          • optionalHeaderValuePF
            • Signature
            • Description
        • HostDirectives
          • host
            • Signature
            • Description
            • Example
          • hostName
            • Signature
            • Description
            • Example
        • Marshalling Directives
          • entity
            • Signature
            • Description
            • Examples
          • produce
            • Signature
            • Description
            • Examples
          • handleWith
            • Signature
            • Description
            • Examples
          • Understanding Specific Marshalling Directives
        • MethodDirectives
          • delete
            • Signature
            • Description
            • Example
          • get
            • Signature
            • Description
            • Example
          • head
            • Signature
            • Description
            • Example
          • method
            • Signature
            • Description
            • Example
          • options
            • Signature
            • Description
            • Example
          • overrideMethodWithParameter
          • patch
            • Signature
            • Description
            • Example
          • post
            • Signature
            • Description
            • Example
          • put
            • Signature
            • Description
            • Example
        • MiscDirectives
          • cancelAllRejections
            • Signature
            • Description
            • Example
          • cancelRejection
            • Signature
            • Description
            • Example
          • clientIP
            • Signature
            • Description
            • Example
          • jsonpWithParameter
            • Signature
            • Description
            • Example
          • rejectEmptyResponse
            • Signature
            • Description
            • Example
          • requestEntityEmpty
            • Signature
            • Description
            • Example
          • requestEntityPresent
            • Signature
            • Description
            • Example
          • requestInstance
            • Signature
            • Description
            • Example
          • requestUri
            • Signature
            • Description
            • Example
          • rewriteUnmatchedPath
            • Signature
            • Description
            • Example
          • unmatchedPath
            • Signature
            • Description
            • Example
          • validate
            • Signature
            • Example
        • ParameterDirectives
          • parameter
            • Signature
            • Description
            • Example
          • parameterMap
            • Signature
            • Description
            • Example
          • parameterMultiMap
            • Signature
            • Description
            • Example
          • parameters
            • Signature
            • Description
            • Examples
              • Required parameter
              • Optional parameter
              • Optional parameter with default value
              • Parameter with required value
              • Deserialized parameter
          • parameterSeq
            • Signature
            • Description
            • Example
          • When to use which parameter directive?
        • PathDirectives
          • path
            • Signature
            • Description
            • Example
          • pathEnd
            • Signature
            • Description
            • Example
          • pathEndOrSingleSlash
            • Signature
            • Description
            • Example
          • pathPrefix
            • Signature
            • Description
            • Example
          • pathPrefixTest
            • Signature
            • Description
            • Example
          • pathSingleSlash
            • Signature
            • Description
            • Example
          • pathSuffix
            • Signature
            • Description
            • Example
          • pathSuffixTest
            • Signature
            • Description
            • Example
          • rawPathPrefix
            • Signature
            • Description
            • Example
          • rawPathPrefixTest
            • Signature
            • Description
            • Example
          • The PathMatcher DSL
            • Overview
            • Basic PathMatchers
            • Combinators
            • Modifiers
            • Examples
        • RangeDirectives
          • withRangeSupport
            • Signature
            • Description
            • Example
        • RespondWithDirectives
          • respondWithHeader
            • Signature
            • Description
            • Example
          • respondWithHeaders
            • Signature
            • Description
            • Example
          • respondWithMediaType
            • Signature
            • Description
            • Example
          • respondWithSingletonHeader
            • Signature
            • Description
            • Example
          • respondWithSingletonHeaders
            • Signature
            • Description
            • Example
          • respondWithStatus
            • Signature
            • Description
            • Example
        • RouteDirectives
          • complete
            • Signature
            • Description
            • Example
          • failWith
            • Signature
            • Description
            • Example
          • redirect
            • Signature
            • Description
            • Example
          • reject
            • Signature
            • Description
            • Example
        • SchemeDirectives
          • scheme
            • Signature
            • Description
            • Example
          • schemeName
            • Signature
            • Description
            • Example
        • SecurityDirectives
          • authenticate
            • Signature
            • Description
              • HTTP Basic Authentication
                • Implementing a UserPassAuthenticator
                • From configuration
                • From LDAP
          • authorize
            • Signature
            • Description
            • Example
          • optionalAuthenticate
            • Signature
            • Description
          • Authentication vs. Authorization
    • Complete Examples
      • on-spray-can
      • on-jetty
      • simple-routing-app
    • Minimal Example
    • Longer Example
  • spray-servlet
    • Dependencies
    • Installation
    • Configuration
    • Basic Architecture
    • Starting and Stopping
    • Message Protocol
      • Request-Response Cycle
      • Chunked Responses
      • Request Timeouts
      • Send Confirmations
      • Closed Notifications
    • HTTP Headers
    • Accessing HttpServletRequest
    • Differences to spray-can
    • Packaging a WAR file
    • Example
      • simple-spray-servlet-server
  • spray-testkit
    • Dependencies
    • Installation
    • Usage
    • Sealing Routes
    • Examples
  • spray-util
    • Dependencies
    • Installation
    • Configuration
    • Pimps
    • LoggingContext
• Project Info
  • Current Versions
  • Maven Repository