com.ibm.cics.osgi.classification

Interface ICICSHttpRunnable

  • All Superinterfaces:
    java.lang.Runnable


    public interface ICICSHttpRunnable
    extends java.lang.Runnable
    This interface provides access to information about an HTTP Request received in Liberty. Implementers of the ICICSTransactionSelector interface may use this data as part of the CICS Transaction mapping process.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      Copyright
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.String getHttpHeader(java.lang.String headerName)
      Returns the value of the first named HTTP Header from the current HTTP request
      java.util.List<java.lang.String> getHttpHeaderList()
      Returns a list of all HTTP Header names for the current HTTP request
      java.util.List<java.lang.String> getHttpHeaders(java.lang.String headerName)
      Returns the value of all named HTTP Header from the current HTTP request
      java.lang.String getHttpMethod()
      Access the HTTP Method for the current HTTP request
      java.lang.String getLocalIPAddress() 
      int getLocalIPFamily() 
      int getLocalPort() 
      java.lang.String getPath()
      Access the URL Path for the current HTTP request E.g.
      java.lang.String getQueryString()
      Access the URL Query String for the current HTTP request
      java.lang.String getRemoteIPAddress() 
      int getRemoteIPFamily() 
      int getRemotePort() 
      java.lang.String getScheme()
      Access the URL Scheme for the current HTTP request
      java.lang.String getURL()
      Access the URL for the current HTTP request, minus any query string E.g.
      • Methods inherited from interface java.lang.Runnable

        run
    • Method Detail

      • getURL

        java.lang.String getURL()
        Access the URL for the current HTTP request, minus any query string E.g. https://example.org/my/path
        Returns:
        - the URL
      • getPath

        java.lang.String getPath()
        Access the URL Path for the current HTTP request E.g. /my/path
        Returns:
        - the Path
      • getScheme

        java.lang.String getScheme()
        Access the URL Scheme for the current HTTP request
        Returns:
        HTTP or HTTPS
      • getRemoteIPAddress

        java.lang.String getRemoteIPAddress()
        Returns:
        - the remote (client) IP address
      • getRemoteIPFamily

        int getRemoteIPFamily()
        Returns:
        - the remote (client) IP Family
      • getRemotePort

        int getRemotePort()
        Returns:
        - the remote (client) port number
      • getLocalIPAddress

        java.lang.String getLocalIPAddress()
        Returns:
        - the local (server) IP address
      • getLocalIPFamily

        int getLocalIPFamily()
        Returns:
        - the local (server) IP family
      • getLocalPort

        int getLocalPort()
        Returns:
        - the local (server) port number
      • getQueryString

        java.lang.String getQueryString()
        Access the URL Query String for the current HTTP request
        Returns:
        - the Query String for the request, or null if absent
      • getHttpMethod

        java.lang.String getHttpMethod()
        Access the HTTP Method for the current HTTP request
        Returns:
        - the HTTP Method used (GET, POST, etc.)
      • getHttpHeader

        java.lang.String getHttpHeader(java.lang.String headerName)
        Returns the value of the first named HTTP Header from the current HTTP request
        Parameters:
        headerName - - the name of the Header
        Returns:
        - the value associated with that Header, or null if the Header doesn't exist
      • getHttpHeaders

        java.util.List<java.lang.String> getHttpHeaders(java.lang.String headerName)
        Returns the value of all named HTTP Header from the current HTTP request
        Parameters:
        headerName - - the name of the Header
        Returns:
        - the list of values associated with that Header
      • getHttpHeaderList

        java.util.List<java.lang.String> getHttpHeaderList()
        Returns a list of all HTTP Header names for the current HTTP request
        Returns:
        - list of HTTP Header names