Class List Method List File List

# Class: Vertx::HttpServerRequest

Inherits:
  Object
  - Object
  - Vertx::HttpServerRequest
  show all
Includes:
  ReadStream
Defined in:
  /Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb

## Instance Method Summary (collapse)

- - (Object) absolute_uri
- - (Object) body_handler
- - (Object) connection
- - (Object) custom_frame_handler
- - (Object) end_handler
- - (Boolean) ended?
- - (Object) exception_handler
- - (Boolean) expect_multipart?
- - (Object) form_attributes
- - (Object) get_form_attribute(attributeName = nil)
- - (Object) get_header(headerName = nil)
- - (Object) get_param(paramName = nil)
- - (Object) handler
- - (Object) headers
- - (Object) host
- - (HttpServerRequest) initialize(j_del) constructor
  A new instance of HttpServerRequest.
- - (Object) j_del
- - (Object) local_address
- - (Object) method
- - (Object) net_socket
- - (Object) params
- - (Object) path
- - (Object) pause
- - (Object) query
- - (Object) raw_method
- - (Object) remote_address
- - (Object) response
- - (Object) resume
- - (Object) scheme
- - (Object) set_expect_multipart(expect = nil)
- - (Boolean) ssl?
- - (Object) upgrade
- - (Object) upload_handler
- - (Object) uri
- - (Object) version

## Constructor Details

### - (`HttpServerRequest`) initialize(j_del)

Returns a new instance of HttpServerRequest

    27
    28
    29
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 27

    def initialize(j_del)
      @j_del = j_del
    end

## Instance Method Details

### - (`Object`) absolute_uri

Raises:

- (`ArgumentError`)

    210
    211
    212
    213
    214
    215
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 210

    def absolute_uri
      if !block_given?
        return @j_del.java_method(:absoluteURI, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling absolute_uri()"
    end

### - (`Object`) body_handler

Raises:

- (`ArgumentError`)

    222
    223
    224
    225
    226
    227
    228
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 222

    def body_handler
      if block_given?
        @j_del.java_method(:bodyHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Buffer)) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling body_handler()"
    end

### - (`Object`) connection

Raises:

- (`ArgumentError`)

    331
    332
    333
    334
    335
    336
    337
    338
    339
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 331

    def connection
      if !block_given?
        if @cached_connection != nil
          return @cached_connection
        end
        return @cached_connection = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:connection, []).call(),::Vertx::HttpConnection)
      end
      raise ArgumentError, "Invalid arguments when calling connection()"
    end

### - (`Object`) custom_frame_handler

Raises:

- (`ArgumentError`)

    323
    324
    325
    326
    327
    328
    329
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 323

    def custom_frame_handler
      if block_given?
        @j_del.java_method(:customFrameHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpFrame)) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling custom_frame_handler()"
    end

### - (`Object`) end_handler

Raises:

- (`ArgumentError`)

    71
    72
    73
    74
    75
    76
    77
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 71

    def end_handler
      if block_given?
        @j_del.java_method(:endHandler, [Java::IoVertxCore::Handler.java_class]).call(Proc.new { yield })
        return self
      end
      raise ArgumentError, "Invalid arguments when calling end_handler()"
    end

### - (`Boolean`) ended?

Returns:

- (`Boolean`)

Raises:

- (`ArgumentError`)

    313
    314
    315
    316
    317
    318
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 313

    def ended?
      if !block_given?
        return @j_del.java_method(:isEnded, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling ended?()"
    end

### - (`Object`) exception_handler

Raises:

- (`ArgumentError`)

    37
    38
    39
    40
    41
    42
    43
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 37

    def exception_handler
      if block_given?
        @j_del.java_method(:exceptionHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling exception_handler()"
    end

### - (`Boolean`) expect_multipart?

Returns:

- (`Boolean`)

Raises:

- (`ArgumentError`)

    258
    259
    260
    261
    262
    263
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 258

    def expect_multipart?
      if !block_given?
        return @j_del.java_method(:isExpectMultipart, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling expect_multipart?()"
    end

### - (`Object`) form_attributes

Raises:

- (`ArgumentError`)

    282
    283
    284
    285
    286
    287
    288
    289
    290
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 282

    def form_attributes
      if !block_given?
        if @cached_form_attributes != nil
          return @cached_form_attributes
        end
        return @cached_form_attributes = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:formAttributes, []).call(),::Vertx::MultiMap)
      end
      raise ArgumentError, "Invalid arguments when calling form_attributes()"
    end

### - (`Object`) get_form_attribute(attributeName = nil)

Raises:

- (`ArgumentError`)

    294
    295
    296
    297
    298
    299
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 294

    def get_form_attribute(attributeName=nil)
      if attributeName.class == String && !block_given?
        return @j_del.java_method(:getFormAttribute, [Java::java.lang.String.java_class]).call(attributeName)
      end
      raise ArgumentError, "Invalid arguments when calling get_form_attribute(attributeName)"
    end

### - (`Object`) get_header(headerName = nil)

Raises:

- (`ArgumentError`)

    164
    165
    166
    167
    168
    169
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 164

    def get_header(headerName=nil)
      if headerName.class == String && !block_given?
        return @j_del.java_method(:getHeader, [Java::java.lang.String.java_class]).call(headerName)
      end
      raise ArgumentError, "Invalid arguments when calling get_header(headerName)"
    end

### - (`Object`) get_param(paramName = nil)

Raises:

- (`ArgumentError`)

    183
    184
    185
    186
    187
    188
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 183

    def get_param(paramName=nil)
      if paramName.class == String && !block_given?
        return @j_del.java_method(:getParam, [Java::java.lang.String.java_class]).call(paramName)
      end
      raise ArgumentError, "Invalid arguments when calling get_param(paramName)"
    end

### - (`Object`) handler

Raises:

- (`ArgumentError`)

    46
    47
    48
    49
    50
    51
    52
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 46

    def handler
      if block_given?
        @j_del.java_method(:handler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Buffer)) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling handler()"
    end

### - (`Object`) headers

Raises:

- (`ArgumentError`)

    152
    153
    154
    155
    156
    157
    158
    159
    160
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 152

    def headers
      if !block_given?
        if @cached_headers != nil
          return @cached_headers
        end
        return @cached_headers = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:headers, []).call(),::Vertx::MultiMap)
      end
      raise ArgumentError, "Invalid arguments when calling headers()"
    end

### - (`Object`) host

Raises:

- (`ArgumentError`)

    135
    136
    137
    138
    139
    140
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 135

    def host
      if !block_given?
        return @j_del.java_method(:host, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling host()"
    end

### - (`Object`) j_del

    32
    33
    34
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 32

    def j_del
      @j_del
    end

### - (`Object`) local_address

Raises:

- (`ArgumentError`)

    200
    201
    202
    203
    204
    205
    206
    207
    208
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 200

    def local_address
      if !block_given?
        if @cached_local_address != nil
          return @cached_local_address
        end
        return @cached_local_address = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:localAddress, []).call(),::Vertx::SocketAddress)
      end
      raise ArgumentError, "Invalid arguments when calling local_address()"
    end

### - (`Object`) method

Raises:

- (`ArgumentError`)

    86
    87
    88
    89
    90
    91
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 86

    def method
      if !block_given?
        return @j_del.java_method(:method, []).call().name.intern
      end
      raise ArgumentError, "Invalid arguments when calling method()"
    end

### - (`Object`) net_socket

Raises:

- (`ArgumentError`)

    237
    238
    239
    240
    241
    242
    243
    244
    245
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 237

    def net_socket
      if !block_given?
        if @cached_net_socket != nil
          return @cached_net_socket
        end
        return @cached_net_socket = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:netSocket, []).call(),::Vertx::NetSocket)
      end
      raise ArgumentError, "Invalid arguments when calling net_socket()"
    end

### - (`Object`) params

Raises:

- (`ArgumentError`)

    171
    172
    173
    174
    175
    176
    177
    178
    179
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 171

    def params
      if !block_given?
        if @cached_params != nil
          return @cached_params
        end
        return @cached_params = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:params, []).call(),::Vertx::MultiMap)
      end
      raise ArgumentError, "Invalid arguments when calling params()"
    end

### - (`Object`) path

Raises:

- (`ArgumentError`)

    121
    122
    123
    124
    125
    126
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 121

    def path
      if !block_given?
        return @j_del.java_method(:path, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling path()"
    end

### - (`Object`) pause

Raises:

- (`ArgumentError`)

    54
    55
    56
    57
    58
    59
    60
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 54

    def pause
      if !block_given?
        @j_del.java_method(:pause, []).call()
        return self
      end
      raise ArgumentError, "Invalid arguments when calling pause()"
    end

### - (`Object`) query

Raises:

- (`ArgumentError`)

    128
    129
    130
    131
    132
    133
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 128

    def query
      if !block_given?
        return @j_del.java_method(:query, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling query()"
    end

### - (`Object`) raw_method

Raises:

- (`ArgumentError`)

    93
    94
    95
    96
    97
    98
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 93

    def raw_method
      if !block_given?
        return @j_del.java_method(:rawMethod, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling raw_method()"
    end

### - (`Object`) remote_address

Raises:

- (`ArgumentError`)

    190
    191
    192
    193
    194
    195
    196
    197
    198
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 190

    def remote_address
      if !block_given?
        if @cached_remote_address != nil
          return @cached_remote_address
        end
        return @cached_remote_address = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:remoteAddress, []).call(),::Vertx::SocketAddress)
      end
      raise ArgumentError, "Invalid arguments when calling remote_address()"
    end

### - (`Object`) response

Raises:

- (`ArgumentError`)

    142
    143
    144
    145
    146
    147
    148
    149
    150
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 142

    def response
      if !block_given?
        if @cached_response != nil
          return @cached_response
        end
        return @cached_response = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:response, []).call(),::Vertx::HttpServerResponse)
      end
      raise ArgumentError, "Invalid arguments when calling response()"
    end

### - (`Object`) resume

Raises:

- (`ArgumentError`)

    62
    63
    64
    65
    66
    67
    68
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 62

    def resume
      if !block_given?
        @j_del.java_method(:resume, []).call()
        return self
      end
      raise ArgumentError, "Invalid arguments when calling resume()"
    end

### - (`Object`) scheme

Raises:

- (`ArgumentError`)

    107
    108
    109
    110
    111
    112
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 107

    def scheme
      if !block_given?
        return @j_del.java_method(:scheme, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling scheme()"
    end

### - (`Object`) set_expect_multipart(expect = nil)

Raises:

- (`ArgumentError`)

    250
    251
    252
    253
    254
    255
    256
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 250

    def set_expect_multipart(expect=nil)
      if (expect.class == TrueClass || expect.class == FalseClass) && !block_given?
        @j_del.java_method(:setExpectMultipart, [Java::boolean.java_class]).call(expect)
        return self
      end
      raise ArgumentError, "Invalid arguments when calling set_expect_multipart(expect)"
    end

### - (`Boolean`) ssl?

Returns:

- (`Boolean`)

Raises:

- (`ArgumentError`)

    100
    101
    102
    103
    104
    105
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 100

    def ssl?
      if !block_given?
        return @j_del.java_method(:isSSL, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling ssl?()"
    end

### - (`Object`) upgrade

Raises:

- (`ArgumentError`)

    305
    306
    307
    308
    309
    310
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 305

    def upgrade
      if !block_given?
        return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:upgrade, []).call(),::Vertx::ServerWebSocket)
      end
      raise ArgumentError, "Invalid arguments when calling upgrade()"
    end

### - (`Object`) upload_handler

Raises:

- (`ArgumentError`)

    268
    269
    270
    271
    272
    273
    274
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 268

    def upload_handler
      if block_given?
        @j_del.java_method(:uploadHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpServerFileUpload)) }))
        return self
      end
      raise ArgumentError, "Invalid arguments when calling upload_handler()"
    end

### - (`Object`) uri

Raises:

- (`ArgumentError`)

    114
    115
    116
    117
    118
    119
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 114

    def uri
      if !block_given?
        return @j_del.java_method(:uri, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling uri()"
    end

### - (`Object`) version

Raises:

- (`ArgumentError`)

    79
    80
    81
    82
    83
    84
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 79

    def version
      if !block_given?
        return @j_del.java_method(:version, []).call().name.intern
      end
      raise ArgumentError, "Invalid arguments when calling version()"
    end