Class ServletEngineEnvironment

Object
AbstractEngineEnvironment
ServletEngineEnvironment
All Implemented Interfaces:
EngineEnvironmentI
Direct Known Subclasses:
HttpEngineEnvironment

public class ServletEngineEnvironment extends AbstractEngineEnvironment
Provides access to request data in a servlet container environment. Instances of this class are passed directly to solution scripts.
Version:
8.1.0
  • Method Details

    • isInstanceOf

      public boolean isInstanceOf(String _sTypeName)
      Checks whether this class or an ancestor is an instance of the given type name.
      Specified by:
      isInstanceOf in interface EngineEnvironmentI
      Overrides:
      isInstanceOf in class AbstractEngineEnvironment
      Returns:
      true if and only if the given type name equals "ServletEngineEnvironment" or one of the type names of the ancestor classes
      Since:
      1.0
    • getCharacterEncoding

      public String getCharacterEncoding()
      Calls ServletRequest.getCharacterEncoding() on the request object.
      Since:
      1.0
    • getContentLength

      public int getContentLength()
      Calls ServletRequest.getContentLength() on the request object.
      Since:
      1.0
    • getContentType

      public String getContentType()
      Calls ServletRequest.getContentType() on the request object.
      Since:
      1.0
    • getInputStream

      public ServletInputStream getInputStream() throws IOException
      Calls ServletRequest.getInputStream() on the request object.
      Throws:
      IOException
      Since:
      1.0
    • getLocalAddr

      public String getLocalAddr()
      Calls ServletRequest.getLocalAddr() on the request object.
      Since:
      1.0
    • getLocale

      public Locale getLocale()
      Calls ServletRequest.getLocale() on the request object.
      Since:
      1.0
    • getLocales

      public Enumeration<Locale> getLocales()
      Calls ServletRequest.getLocales() on the request object.
      Since:
      1.0
    • getLocalName

      public String getLocalName()
      Calls ServletRequest.getLocalName() on the request object.
      Since:
      1.0
    • getLocalPort

      public int getLocalPort()
      Calls ServletRequest.getLocalPort() on the request object.
      Since:
      1.0
    • getParameter

      public String getParameter(String _sName)
      Calls ServletRequest.getParameter(java.lang.String) on the request object.
      Since:
      1.0
    • getParameterMap

      public Map<String,String[]> getParameterMap()
      Calls ServletRequest.getParameterMap() on the request object.
      Since:
      1.0
      See Also:
    • getParameters

      public Map<String,Object> getParameters()
      Returns arbitrary typed request parameters parsed from the request body content. Also contains parameters given on the request URL. The parameter values can be null, of a primitive type (like Boolean, Number, String), or of type List<Object> or Map<String,Object> (also nested), eventually containing elements/values of a primitive type. The actual object layout depends on the request data.

      This is an extension of standard servlet API method getParameterMap(). The returned map contains all parameters also returned by that method, but the parameter values are not restricted to type String.

      Since:
      6.0
      See Also:
    • getProtocol

      public String getProtocol()
      Calls ServletRequest.getProtocol() on the request object.
      Since:
      1.0
    • getReader

      public BufferedReader getReader() throws IOException
      Calls ServletRequest.getReader() on the request object.
      Throws:
      IOException
      Since:
      1.0
    • getRemoteAddr

      public String getRemoteAddr()
      Calls ServletRequest.getRemoteAddr() on the request object.
      Since:
      1.0
    • getRemoteHost

      public String getRemoteHost()
      Calls ServletRequest.getRemoteHost() on the request object.
      Since:
      1.0
    • getRemotePort

      public int getRemotePort()
      Calls ServletRequest.getRemotePort() on the request object.
      Since:
      1.0
    • getServerName

      public String getServerName()
      Calls ServletRequest.getServerName() on the request object.
      Since:
      1.0
    • getServerPort

      public int getServerPort()
      Calls ServletRequest.getServerPort() on the request object.
      Since:
      1.0
    • isSecure

      public boolean isSecure()
      Calls ServletRequest.isSecure() on the request object.
      Since:
      1.0