com.hivemq.spi.bridge

Enum StartType

java.lang.Object

java.lang.Enum<StartType>

com.hivemq.spi.bridge.StartType

All Implemented Interfaces:

Serializable, Comparable<StartType>

Deprecated.

@Deprecated
public enum StartType
extends Enum<StartType>

The start type of a bridge.

Since:

2.0

Author:

Dominik Obermaier

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTOMATIC Deprecated. The bridge connection will be started automatically when the broker starts and it will try with best effort to reconnect if the connection drops or if the connection failed.
LAZY Deprecated. This bridge will not start automatically on broker startup.
MANUAL Deprecated. This bridge will not start and stop automatically.
ONCE Deprecated. This bridge will start automatically on broker startup.

Method Summary

Methods

Modifier and Type	Method and Description
static StartType	valueOf(String name) Deprecated. Returns the enum constant of this type with the specified name.
static StartType[]	values() Deprecated. 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

AUTOMATIC

public static final StartType AUTOMATIC

Deprecated.

The bridge connection will be started automatically when the broker starts and it will try with best effort to reconnect if the connection drops or if the connection failed.

This is the default connection type

LAZY

public static final StartType LAZY

Deprecated.

This bridge will not start automatically on broker startup. Lazy bridges queue messages until a threshold is reached and then they connect to the remote broker. After a idle timeout it will automatically disconnect again if no messages are delivered in the meantime

This type is very useful if you only want to connect a bridge if needed for if you want to do "batching". If you want to use the lazy mode for batching, consider setting the idle timeout to a very low value.

Please make sure that the idle timeout is shorter than the keepAlive value, otherwise a bridge connection is never considered idle

MANUAL

public static final StartType MANUAL

Deprecated.

This bridge will not start and stop automatically. You must use a plugin which utilizes the BridgeManagerService to start and stop this type of bridge.

This bridge won't reconnect automatically if it disconnected unexpectedly, so make sure you implemented some kind of heartbeat when using this bridge type.

ONCE

public static final StartType ONCE

Deprecated.

This bridge will start automatically on broker startup. If the connection drops, this bridge type won't try to reconnect.

It is possible to restart this type of bridge manually with the BridgeManagerService in HiveMQ plugins

Method Detail

values

public static StartType[] values()

Deprecated.

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 (StartType c : StartType.values())
    System.out.println(c);

Returns:

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

valueOf

public static StartType valueOf(String name)

Deprecated.

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