Package io.inversion

Class Request

  • All Implemented Interfaces:
    Headers, io.inversion.json.JSFind
    public class Request
extends java.lang.Object
implements Headers, io.inversion.json.JSFind

    • Constructor Detail

      • Request

        public Request()

      • Request

        public Request​(java.lang.String method,
               java.lang.String url)

      • Request

        public Request​(java.lang.String method,
               java.lang.String url,
               java.lang.String body)

      • Request

        public Request​(Engine engine,
               java.lang.String method,
               java.lang.String url,
               java.lang.Object body)

      • Request

        public Request​(java.lang.String method,
               java.lang.String url,
               java.lang.String body,
               io.inversion.utils.ListMap<java.lang.String,​java.lang.String> headers)

      • Request

        public Request​(java.lang.String method,
               java.lang.String url,
               java.lang.String body,
               java.util.Map<java.lang.String,​java.lang.String> params,
               io.inversion.utils.ListMap<java.lang.String,​java.lang.String> headers)

    • Method Detail

      • findParam

        public java.lang.String findParam​(java.lang.String name,
                                  Param.In... where)

      • withUrl

        public Request withUrl​(java.lang.String url)

      • getStartAt

        public long getStartAt()

      • withStartAt

        public Request withStartAt​(long startAt)

      • getEndAt

        public long getEndAt()

      • withEndAt

        public Request withEndAt​(long endAt)

      • getDuration

        public long getDuration()

      • withMethod

        public Request withMethod​(java.lang.String method)

      • withHeaders

        public Request withHeaders​(java.lang.String key,
                           java.lang.String value)

      • withHeaders

        public Request withHeaders​(io.inversion.json.JSMap headers)

      • getHeaders

        public io.inversion.json.JSMap getHeaders()
        Specified by:
        getHeaders in interface Headers

      • getServer

        public Server getServer()

      • getApi

        public Api getApi()

      • getEngine

        public Engine getEngine()

      • isInternal

        public boolean isInternal()

      • withInternal

        public Request withInternal​(boolean internal)

      • getCollection

        public Collection getCollection()

      • getDb

        public Db getDb()

      • getDbPath

        public io.inversion.utils.Path getDbPath()

      • withDbPath

        public Request withDbPath​(io.inversion.utils.Path dbPath)

      • getEndpoint

        public Endpoint getEndpoint()

      • getServerPath

        public io.inversion.utils.Path getServerPath()

      • withServerPath

        public Request withServerPath​(io.inversion.utils.Path serverPath)

      • getServerPathMatch

        public io.inversion.utils.Path getServerPathMatch()

      • withServerPathMatch

        public Request withServerPathMatch​(io.inversion.utils.Path serverPathMatch)

      • getOperationPath

        public io.inversion.utils.Path getOperationPath()

      • withOperationPath

        public Request withOperationPath​(io.inversion.utils.Path operationPath)

      • getEndpointPath

        public io.inversion.utils.Path getEndpointPath()

      • withEndpointPath

        public Request withEndpointPath​(io.inversion.utils.Path endpointPath)

      • getActionPath

        public io.inversion.utils.Path getActionPath()

      • withActionPath

        public Request withActionPath​(io.inversion.utils.Path actionPath)

      • getCollectionPath

        public io.inversion.utils.Path getCollectionPath()

      • withCollectionPath

        public Request withCollectionPath​(io.inversion.utils.Path collectionPath)

      • withPathParams

        public Request withPathParams​(java.util.Map<java.lang.String,​java.lang.String> pathParams)

      • getPathParams

        public java.util.Map<java.lang.String,​java.lang.String> getPathParams()

      • isDebug

        public boolean isDebug()

      • isExplain

        public boolean isExplain()

      • withExplain

        public Request withExplain​(boolean explain)

      • getBody

        public java.lang.String getBody()

      • withBody

        public Request withBody​(java.lang.String body)

      • getJson

        public io.inversion.json.JSNode getJson()
                                 throws ApiException
        Specified by:
        getJson in interface io.inversion.json.JSFind
        Throws:
        ApiException

      • getData

        public io.inversion.json.JSList getData()
        Attempts to massage an inbound json body into an array.

        This is useful so actions can treat all inbound requests as if they are arrays instead of having to check.

        Conversion rules:

        1. if getBody() is a JSList return it.
        2. if getBody() is a JSNode with a "data" array prop, return it
        3. if getBody() is a JSNode with a "_embedded" array prop, return it
        4. if getBody() is a JSNode wrap it in an array and return it.
        5. if getBody() is not a JSNode and getBody() is null, return an empty array.
        Returns:
        the JSON boty messaged into an array

      • withJson

        public Request withJson​(io.inversion.json.JSNode json)

      • getMethod

        public java.lang.String getMethod()
        Returns:
        the method

      • isMethod

        public boolean isMethod​(java.lang.String... methods)

      • isPut

        public boolean isPut()

      • isPost

        public boolean isPost()

      • isPatch

        public boolean isPatch()

      • isGet

        public boolean isGet()

      • isDelete

        public boolean isDelete()

      • isOptions

        public boolean isOptions()

      • getReferrer

        public java.lang.String getReferrer()

      • getChain

        public Chain getChain()

      • getUrl

        public Url getUrl()

      • getCollectionKey

        public java.lang.String getCollectionKey()
        Returns:
        the collectionKey

      • getResourceKey

        public java.lang.String getResourceKey()
        Returns:
        the resourceKey

      • getRelationshipKey

        public java.lang.String getRelationshipKey()

      • getApiUrl

        public java.lang.String getApiUrl()

      • getPath

        public io.inversion.utils.Path getPath()

      • getSubpath

        public io.inversion.utils.Path getSubpath()

      • getOp

        public Op getOp()

      • getRemoteAddr

        public java.lang.String getRemoteAddr()

      • withRemoteAddr

        public Request withRemoteAddr​(java.lang.String remoteAddr)

      • getUploader

        public Uploader getUploader()

      • getUploads

        public java.util.List<Upload> getUploads()

      • validate

        public Validation validate​(java.lang.String propOrJsonPath)

      • validate

        public Validation validate​(java.lang.String propOrJsonPath,
                           java.lang.String customErrorMessage)

      • check

        public void check​(boolean value,
                  java.lang.String message,
                  java.lang.Object... args)