Packages

trait ApiGatewayHandler extends LambdaHandler[AwsProxyRequest, AwsProxyResponse] with ApiGatewayResponse with LambdaConfiguration

Linear Supertypes
ApiGatewayResponse, LambdaHandler[AwsProxyRequest, AwsProxyResponse], LambdaConfiguration, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ApiGatewayHandler
  2. ApiGatewayResponse
  3. LambdaHandler
  4. LambdaConfiguration
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def execute(event: AwsProxyRequest, context: Context): AwsProxyResponse

    This method should be implemented by all lambda functions a and is called by the lambda handler.

    This method should be implemented by all lambda functions a and is called by the lambda handler. Please note that the main entry to the lambda codeBlock should be the "lambdaHandler".

    event

    TEvent

    context

    AWS Context

    returns

    TResponse, if not response is required set this to Unit

    Definition Classes
    LambdaHandler
  2. abstract def getValue(path: String): Option[String]

    Get configuration values by name.

    Get configuration values by name. This assumes that the name uses a path notation

    path

    name of the configuration value

    Definition Classes
    LambdaConfiguration
  3. abstract def getValues(path: String): Map[String, String]

    Get multiple values using a prefix.

    Get multiple values using a prefix. e.g. the path "/database" would return /database/username, /database/password, /database/port, /database/host, etc.

    path

    name of the path to search for

    Definition Classes
    LambdaConfiguration

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def buildError(code: Int, message: String): AwsProxyResponse

    Helper method to build an error response

    Helper method to build an error response

    code

    HTTP Code

    message

    The error message

    returns

    AwsProxyResponse

    Attributes
    protected
    Definition Classes
    ApiGatewayResponse
  6. def buildResponse(code: Int, payload: AnyRef): AwsProxyResponse

    Helper methods to build the AWS Proxy Response

    Helper methods to build the AWS Proxy Response

    code

    HTTP Code

    payload

    The payload that will be in the body of the response

    returns

    AwsProxyResponse

    Attributes
    protected
    Definition Classes
    ApiGatewayResponse
  7. def buildResponse(code: Int, payload: AnyRef, headers: Map[String, String]): AwsProxyResponse

    Helper methods to build the AWS Proxy Response

    Helper methods to build the AWS Proxy Response

    code

    HTTP Code

    payload

    The payload that will be in the body of the response

    headers

    Map of headers

    returns

    AwsProxyResponse

    Attributes
    protected
    Definition Classes
    ApiGatewayResponse
  8. def buildResponse(code: Int, headers: Map[String, String] = Map()): AwsProxyResponse

    Helper methods to build the AWS Proxy Response

    Helper methods to build the AWS Proxy Response

    code

    HTTP Code

    headers

    Map of headers

    returns

    AwsProxyResponse

    Attributes
    protected
    Definition Classes
    ApiGatewayResponse
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def exceptionListener(listener: (Throwable) ⇒ Unit): Unit

    Add custom logic in the handleFailure method before raising the exception

    Add custom logic in the handleFailure method before raising the exception

    listener

    function

    Attributes
    protected
    Definition Classes
    LambdaHandler
  13. val exceptionListeners: ArrayBuffer[(Throwable) ⇒ Unit]
    Attributes
    protected
    Definition Classes
    LambdaHandler
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def handle(codeBlock: ⇒ AwsProxyResponse): Option[AwsProxyResponse]

    Execute the function code and handles errors using the functionHandler.

    Execute the function code and handles errors using the functionHandler. It returns None if the response type is Unit, otherwise it returns an Option of TResponse.

    codeBlock

    any codeBlock that returns a TResponse

    returns

    Option[TResponse]

    Attributes
    protected
    Definition Classes
    LambdaHandler
  17. def handleFailure(exception: Throwable): AwsProxyResponse

    Custom handleFailure method for ApiGateway, will generate a response with a custom error message or a generic message to prevent exposing internal details.

    Custom handleFailure method for ApiGateway, will generate a response with a custom error message or a generic message to prevent exposing internal details.

    exception

    the reported exception

    returns

    TResponse

    Attributes
    protected
    Definition Classes
    ApiGatewayHandler → LambdaHandler
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def isWarmUpEvent(json: String): Boolean

    check if the message is a warm up event or not.

    check if the message is a warm up event or not. Returns true if it is.

    json

    string event

    returns

    Boolean

    Attributes
    protected
    Definition Classes
    LambdaHandler
  21. def jsonDecode(json: String): AwsProxyRequest

    Override this method to use a custom json-decode strategy

    Override this method to use a custom json-decode strategy

    json

    string event

    returns

    TEvent

    Attributes
    protected
    Definition Classes
    LambdaHandler
  22. final def lambdaHandler(inputStream: InputStream, outputStream: OutputStream, context: Context): Unit

    The lambdaHandler is the main entry point to your application and it is in charge of decoding your event, handling errors/notifications, and writing to the output stream.

    The lambdaHandler is the main entry point to your application and it is in charge of decoding your event, handling errors/notifications, and writing to the output stream.

    inputStream

    aws input stream

    outputStream

    aws output stream

    context

    aws lambda context

    Definition Classes
    LambdaHandler
  23. val log: Logger
    Attributes
    protected
    Definition Classes
    ApiGatewayHandler → LambdaHandler
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. val region: String
    Attributes
    protected
    Definition Classes
    LambdaHandler
  28. def responseListener(listener: (AwsProxyResponse) ⇒ AwsProxyResponse): Unit

    Transform the function response using custom functions

    Transform the function response using custom functions

    listener

    function

    Attributes
    protected
    Definition Classes
    LambdaHandler
  29. val responseListeners: ArrayBuffer[(AwsProxyResponse) ⇒ AwsProxyResponse]
    Attributes
    protected
    Definition Classes
    LambdaHandler
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def validationListener(listener: (AwsProxyRequest) ⇒ Unit): Unit

    Validate the request using custom functions

    Validate the request using custom functions

    listener

    function

    Attributes
    protected
    Definition Classes
    LambdaHandler
  33. val validationListeners: ArrayBuffer[(AwsProxyRequest) ⇒ Unit]
    Attributes
    protected
    Definition Classes
    LambdaHandler
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from ApiGatewayResponse

Inherited from LambdaHandler[AwsProxyRequest, AwsProxyResponse]

Inherited from LambdaConfiguration

Inherited from AnyRef

Inherited from Any

Ungrouped