Class List Method List File List

# Class: VertxMqttServer::MqttAuth

Inherits:
  Object
  - Object
  - VertxMqttServer::MqttAuth
  show all
Defined in:
  /Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_auth.rb

## Overview

MQTT authentication information

## Constant Summary

@@j_api_type =

      Object.new

## Class Method Summary (collapse)

- + (Boolean) accept?(obj)
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)

## Instance Method Summary (collapse)

- - (String) password
  The password provided by the remote MQTT client.
- - (String) user_name
  The username provided by the remote MQTT client.

## Class Method Details

### + (`Boolean`) accept?(obj)

Returns:

- (`Boolean`)

    17
    18
    19
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_auth.rb', line 17

    def @@j_api_type.accept?(obj)
      obj.class == MqttAuth
    end

### + (`Object`) j_api_type

    26
    27
    28
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_auth.rb', line 26

    def self.j_api_type
      @@j_api_type
    end

### + (`Object`) j_class

    29
    30
    31
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_auth.rb', line 29

    def self.j_class
      Java::IoVertxMqtt::MqttAuth.java_class
    end

### + (`Object`) unwrap(obj)

    23
    24
    25
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_auth.rb', line 23

    def @@j_api_type.unwrap(obj)
      obj.j_del
    end

### + (`Object`) wrap(obj)

    20
    21
    22
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_auth.rb', line 20

    def @@j_api_type.wrap(obj)
      MqttAuth.new(obj)
    end

## Instance Method Details

### - (`String`) password

Returns the password provided by the remote MQTT client

Returns:

- (`String`) —
  the password provided by the remote MQTT client

Raises:

- (`ArgumentError`)

    40
    41
    42
    43
    44
    45
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_auth.rb', line 40

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

### - (`String`) user_name

Returns the username provided by the remote MQTT client

Returns:

- (`String`) —
  the username provided by the remote MQTT client

Raises:

- (`ArgumentError`)

    33
    34
    35
    36
    37
    38
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_auth.rb', line 33

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