Skip to content

Variable: HttpServletRequestSchema ​

ts
const HttpServletRequestSchema: ZodObject<{
  asyncContext: ZodOptional<ZodType<AsyncContext, AsyncContextInput, $ZodTypeInternals<AsyncContext, AsyncContextInput>>>;
  asyncStarted: ZodOptional<ZodBoolean>;
  asyncSupported: ZodOptional<ZodBoolean>;
  attributeNames: ZodOptional<ZodRecord<ZodString, ZodAny>>;
  authType: ZodOptional<ZodString>;
  characterEncoding: ZodOptional<ZodString>;
  contentLength: ZodOptional<ZodNumber>;
  contentLengthLong: ZodOptional<ZodNumber>;
  contentType: ZodOptional<ZodString>;
  contextPath: ZodOptional<ZodString>;
  cookies: ZodOptional<ZodArray<ZodObject<{
     attributes: ZodOptional<ZodRecord<ZodString, ZodString>>;
     comment: ZodOptional<ZodString>;
     domain: ZodOptional<ZodString>;
     httpOnly: ZodOptional<ZodBoolean>;
     maxAge: ZodOptional<ZodNumber>;
     name: ZodOptional<ZodString>;
     path: ZodOptional<ZodString>;
     secure: ZodOptional<ZodBoolean>;
     value: ZodOptional<ZodString>;
     version: ZodOptional<ZodNumber>;
  }, ApiObjectConfig<undefined>>>>;
  dispatcherType: ZodOptional<ZodCustom<string & object | "ERROR" | "FORWARD" | "INCLUDE" | "REQUEST" | "ASYNC", string & object | "ERROR" | "FORWARD" | "INCLUDE" | "REQUEST" | "ASYNC">>;
  headerNames: ZodOptional<ZodRecord<ZodString, ZodAny>>;
  httpServletMapping: ZodOptional<ZodObject<{
     mappingMatch: ZodOptional<ZodCustom<
        | string & object
        | "DEFAULT"
        | "CONTEXT_ROOT"
        | "EXACT"
        | "EXTENSION"
        | "PATH", 
        | string & object
        | "DEFAULT"
        | "CONTEXT_ROOT"
        | "EXACT"
        | "EXTENSION"
       | "PATH">>;
     matchValue: ZodOptional<ZodString>;
     pattern: ZodOptional<ZodString>;
     servletName: ZodOptional<ZodString>;
  }, ApiObjectConfig<undefined>>>;
  inputStream: ZodOptional<ZodObject<{
     finished: ZodOptional<ZodBoolean>;
     readListener: ZodOptional<ZodObject<{
     }, ApiObjectConfig<undefined>>>;
     ready: ZodOptional<ZodBoolean>;
  }, ApiObjectConfig<undefined>>>;
  localAddr: ZodOptional<ZodString>;
  locale: ZodOptional<ZodObject<{
     country: ZodOptional<ZodString>;
     displayCountry: ZodOptional<ZodString>;
     displayLanguage: ZodOptional<ZodString>;
     displayName: ZodOptional<ZodString>;
     displayScript: ZodOptional<ZodString>;
     displayVariant: ZodOptional<ZodString>;
     extensionKeys: ZodOptional<ZodArray<ZodString>>;
     iso3Country: ZodOptional<ZodString>;
     iso3Language: ZodOptional<ZodString>;
     language: ZodOptional<ZodString>;
     script: ZodOptional<ZodString>;
     unicodeLocaleAttributes: ZodOptional<ZodArray<ZodString>>;
     unicodeLocaleKeys: ZodOptional<ZodArray<ZodString>>;
     variant: ZodOptional<ZodString>;
  }, ApiObjectConfig<undefined>>>;
  locales: ZodOptional<ZodRecord<ZodString, ZodAny>>;
  localName: ZodOptional<ZodString>;
  localPort: ZodOptional<ZodNumber>;
  method: ZodOptional<ZodString>;
  parameterMap: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString>>>;
  parameterNames: ZodOptional<ZodRecord<ZodString, ZodAny>>;
  parts: ZodOptional<ZodArray<ZodObject<{
     contentType: ZodOptional<ZodString>;
     headerNames: ZodOptional<ZodArray<ZodString>>;
     inputStream: ZodOptional<ZodRecord<ZodString, ZodAny>>;
     name: ZodOptional<ZodString>;
     size: ZodOptional<ZodNumber>;
     submittedFileName: ZodOptional<ZodString>;
  }, ApiObjectConfig<undefined>>>>;
  pathInfo: ZodOptional<ZodString>;
  pathTranslated: ZodOptional<ZodString>;
  protocol: ZodOptional<ZodString>;
  protocolRequestId: ZodOptional<ZodString>;
  queryString: ZodOptional<ZodString>;
  reader: ZodOptional<ZodRecord<ZodString, ZodAny>>;
  remoteAddr: ZodOptional<ZodString>;
  remoteHost: ZodOptional<ZodString>;
  remotePort: ZodOptional<ZodNumber>;
  remoteUser: ZodOptional<ZodString>;
  requestedSessionId: ZodOptional<ZodString>;
  requestedSessionIdFromCookie: ZodOptional<ZodBoolean>;
  requestedSessionIdFromURL: ZodOptional<ZodBoolean>;
  requestedSessionIdValid: ZodOptional<ZodBoolean>;
  requestId: ZodOptional<ZodString>;
  requestURI: ZodOptional<ZodString>;
  requestURL: ZodOptional<ZodObject<{
     empty: ZodOptional<ZodBoolean>;
     length: ZodOptional<ZodNumber>;
  }, ApiObjectConfig<undefined>>>;
  scheme: ZodOptional<ZodString>;
  secure: ZodOptional<ZodBoolean>;
  serverName: ZodOptional<ZodString>;
  serverPort: ZodOptional<ZodNumber>;
  servletConnection: ZodOptional<ZodObject<{
     connectionId: ZodOptional<ZodString>;
     protocol: ZodOptional<ZodString>;
     protocolConnectionId: ZodOptional<ZodString>;
     secure: ZodOptional<ZodBoolean>;
  }, ApiObjectConfig<undefined>>>;
  servletContext: ZodOptional<ZodObject<{
     attributeNames: ZodOptional<ZodRecord<ZodString, ZodAny>>;
     classLoader: ZodOptional<ZodObject<{
        defaultAssertionStatus: ZodOptional<ZodBoolean>;
        definedPackages: ZodOptional<ZodArray<ZodObject<..., ...>>>;
        name: ZodOptional<ZodString>;
        parent: ZodOptional<ZodObject<{
           defaultAssertionStatus: ...;
           definedPackages: ...;
           name: ...;
           registeredAsParallelCapable: ...;
           unnamedModule: ...;
        }, ApiObjectConfig<...>>>;
        registeredAsParallelCapable: ZodOptional<ZodBoolean>;
        unnamedModule: ZodOptional<ZodObject<{
           annotations: ...;
           declaredAnnotations: ...;
           descriptor: ...;
           layer: ...;
           name: ...;
           named: ...;
           nativeAccessEnabled: ...;
           packages: ...;
        }, ApiObjectConfig<...>>>;
     }, ApiObjectConfig<undefined>>>;
     contextPath: ZodOptional<ZodString>;
     defaultSessionTrackingModes: ZodOptional<ZodArray<ZodCustom<string & object | "COOKIE" | "URL" | "SSL", string & object | "COOKIE" | "URL" | "SSL">>>;
     effectiveMajorVersion: ZodOptional<ZodNumber>;
     effectiveMinorVersion: ZodOptional<ZodNumber>;
     effectiveSessionTrackingModes: ZodOptional<ZodArray<ZodCustom<string & object | "COOKIE" | "URL" | "SSL", string & object | "COOKIE" | "URL" | "SSL">>>;
     filterRegistrations: ZodOptional<ZodRecord<ZodString, ZodObject<{
        className: ZodOptional<ZodString>;
        initParameters: ZodOptional<ZodRecord<..., ...>>;
        name: ZodOptional<ZodString>;
        servletNameMappings: ZodOptional<ZodArray<...>>;
        urlPatternMappings: ZodOptional<ZodArray<...>>;
     }, ApiObjectConfig<undefined>>>>;
     initParameterNames: ZodOptional<ZodRecord<ZodString, ZodAny>>;
     jspConfigDescriptor: ZodOptional<ZodObject<{
        jspPropertyGroups: ZodOptional<ZodArray<ZodObject<..., ...>>>;
        taglibs: ZodOptional<ZodArray<ZodObject<..., ...>>>;
     }, ApiObjectConfig<undefined>>>;
     majorVersion: ZodOptional<ZodNumber>;
     minorVersion: ZodOptional<ZodNumber>;
     requestCharacterEncoding: ZodOptional<ZodString>;
     responseCharacterEncoding: ZodOptional<ZodString>;
     serverInfo: ZodOptional<ZodString>;
     servletContextName: ZodOptional<ZodString>;
     servletRegistrations: ZodOptional<ZodRecord<ZodString, ZodObject<{
        className: ZodOptional<ZodString>;
        initParameters: ZodOptional<ZodRecord<..., ...>>;
        mappings: ZodOptional<ZodArray<...>>;
        name: ZodOptional<ZodString>;
        runAsRole: ZodOptional<ZodString>;
     }, ApiObjectConfig<undefined>>>>;
     sessionCookieConfig: ZodOptional<ZodObject<{
        attributes: ZodOptional<ZodRecord<ZodString, ZodString>>;
        comment: ZodOptional<ZodString>;
        domain: ZodOptional<ZodString>;
        httpOnly: ZodOptional<ZodBoolean>;
        maxAge: ZodOptional<ZodNumber>;
        name: ZodOptional<ZodString>;
        path: ZodOptional<ZodString>;
        secure: ZodOptional<ZodBoolean>;
     }, ApiObjectConfig<undefined>>>;
     sessionTimeout: ZodOptional<ZodNumber>;
     sessionTrackingModes: ZodOptional<ZodArray<ZodCustom<string & object | "COOKIE" | "URL" | "SSL", string & object | "COOKIE" | "URL" | "SSL">>>;
     virtualServerName: ZodOptional<ZodString>;
  }, ApiObjectConfig<undefined>>>;
  servletPath: ZodOptional<ZodString>;
  session: ZodOptional<ZodObject<{
     attributeNames: ZodOptional<ZodRecord<ZodString, ZodAny>>;
     creationTime: ZodOptional<ZodNumber>;
     id: ZodOptional<ZodString>;
     lastAccessedTime: ZodOptional<ZodNumber>;
     maxInactiveInterval: ZodOptional<ZodNumber>;
     new: ZodOptional<ZodBoolean>;
     servletContext: ZodOptional<ZodObject<{
        attributeNames: ZodOptional<ZodRecord<ZodString, ZodAny>>;
        classLoader: ZodOptional<ZodObject<{
           defaultAssertionStatus: ...;
           definedPackages: ...;
           name: ...;
           parent: ...;
           registeredAsParallelCapable: ...;
           unnamedModule: ...;
        }, ApiObjectConfig<...>>>;
        contextPath: ZodOptional<ZodString>;
        defaultSessionTrackingModes: ZodOptional<ZodArray<ZodCustom<..., ...>>>;
        effectiveMajorVersion: ZodOptional<ZodNumber>;
        effectiveMinorVersion: ZodOptional<ZodNumber>;
        effectiveSessionTrackingModes: ZodOptional<ZodArray<ZodCustom<..., ...>>>;
        filterRegistrations: ZodOptional<ZodRecord<ZodString, ZodObject<..., ...>>>;
        initParameterNames: ZodOptional<ZodRecord<ZodString, ZodAny>>;
        jspConfigDescriptor: ZodOptional<ZodObject<{
           jspPropertyGroups: ...;
           taglibs: ...;
        }, ApiObjectConfig<...>>>;
        majorVersion: ZodOptional<ZodNumber>;
        minorVersion: ZodOptional<ZodNumber>;
        requestCharacterEncoding: ZodOptional<ZodString>;
        responseCharacterEncoding: ZodOptional<ZodString>;
        serverInfo: ZodOptional<ZodString>;
        servletContextName: ZodOptional<ZodString>;
        servletRegistrations: ZodOptional<ZodRecord<ZodString, ZodObject<..., ...>>>;
        sessionCookieConfig: ZodOptional<ZodObject<{
           attributes: ...;
           comment: ...;
           domain: ...;
           httpOnly: ...;
           maxAge: ...;
           name: ...;
           path: ...;
           secure: ...;
        }, ApiObjectConfig<...>>>;
        sessionTimeout: ZodOptional<ZodNumber>;
        sessionTrackingModes: ZodOptional<ZodArray<ZodCustom<..., ...>>>;
        virtualServerName: ZodOptional<ZodString>;
     }, ApiObjectConfig<undefined>>>;
  }, ApiObjectConfig<undefined>>>;
  trailerFields: ZodOptional<ZodRecord<ZodString, ZodString>>;
  trailerFieldsReady: ZodOptional<ZodBoolean>;
  userPrincipal: ZodOptional<ZodObject<{
     name: ZodOptional<ZodString>;
  }, ApiObjectConfig<undefined>>>;
}, ApiObjectConfig<undefined>>;

Defined in: src/server/models/httpServletRequest.ts:12