com.hivemq.spi.services.rest.listener

Class HttpListener

java.lang.Object

com.hivemq.spi.services.rest.listener.HttpListener

All Implemented Interfaces:

Listener

@Immutable
public class HttpListener
extends Object

A HTTP listener which is bound to a specific host and port.

Author:

Dominik Obermaier

Constructor Summary

Constructors

Constructor and Description
HttpListener(String name, String bindAddress, int port) Creates a new HTTP listener.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBindAddress() Returns the bind address the listener is bound to
String	getName() Returns the unique name of the listener
int	getPort() Returns the port the listener is bound to

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpListener

public HttpListener(@NotNull
            String name,
            @NotNull
            String bindAddress,
            int port)

Creates a new HTTP listener.

In order to bind the HTTP listener to all interfaces use the host '0.0.0.0'

Parameters:

name - The unique identifier of the listener.

bindAddress - the bind address the listener should be bound to. Must be a valid IP or hostname.

port - the port the listener should be bound to. Must be between 1 and 65535.

Throws:

NullPointerException - if name or host are null

IllegalArgumentException - if the port is not valid

Method Detail

getName

public String getName()

Returns the unique name of the listener

Returns:

the unique name of the listener

getBindAddress

public String getBindAddress()

Returns the bind address the listener is bound to

Returns:

the the bind address

getPort

public int getPort()

Returns the port the listener is bound to

Returns:

the port of the listener