com.mulesoft.connectors.mqtt3.api

Enum Protocol

java.lang.Object

java.lang.Enum<Protocol>

com.mulesoft.connectors.mqtt3.api.Protocol

All Implemented Interfaces:

Serializable, Comparable<Protocol>

public enum Protocol
extends Enum<Protocol>

Declares the kind of protocol to be used to connect to the broker. There are five protocol options:

• TCP
• SSL
• WS
• WSS
• LOCAL

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOCAL Deliver mqtt messages over local connection.
SSL Deliver mqtt messages over SSL/TLS connection.
TCP Deliver mqtt messages over TCP connection.
WS Deliver mqtt messages using WebSockets connection.
WSS Deliver mqtt messages over Secure WebSockets connection.

Method Summary

Modifier and Type	Method and Description
String	getProtocol()
static Protocol	valueOf(String name) Returns the enum constant of this type with the specified name.
static Protocol[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TCP

public static final Protocol TCP

Deliver mqtt messages over TCP connection.

WS

public static final Protocol WS

Deliver mqtt messages using WebSockets connection.

WSS

public static final Protocol WSS

Deliver mqtt messages over Secure WebSockets connection.

SSL

public static final Protocol SSL

Deliver mqtt messages over SSL/TLS connection.

LOCAL

public static final Protocol LOCAL

Deliver mqtt messages over local connection.

Method Detail

values

public static Protocol[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Protocol c : Protocol.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Protocol valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getProtocol

public String getProtocol()

Returns:

the protocol's scheme.