nl.teslanet.mule.connectors.coap.internal.server

Class Server

java.lang.Object

nl.teslanet.mule.connectors.coap.internal.server.Server

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

@Configuration(name="server")
 @NoImplicit
 @Sources(value=Listener.class)
 @Operations(value=ServerOperations.class)
public class Server
extends Object
implements org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

The CoAP Server configures resources and one or more endpoints. The endpoints make the server resources available to clients.

Field Summary

Fields

Modifier and Type	Field and Description
long	lingerOnShutdown The linger time (in milliseconds [ms]) on shutdown of the server, giving notifications time to complete.
boolean	notifyOnShutdown Notify observing clients of server shutdown.
static String	VARNAME_COAP_EXCHANGE The name of the CoapExchange variable.
static String	VARNAME_DEFAULT_RESPONSE_CODE The name of the default response code variable.

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
Server()

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose of the server.
List<AdditionalEndpoint>	getAdditionalEndpoints()
ResourceRegistry	getRegistry()
List<ResourceConfig>	getResources()
org.mule.runtime.api.scheduler.SchedulerConfig	getSchedulerConfig()
org.mule.runtime.api.scheduler.SchedulerService	getSchedulerService()
String	getServerName()
void	initialise()
void	setAdditionalEndpoints(List<AdditionalEndpoint> endpoints)
void	setResources(List<ResourceConfig> resources)
void	start() Start the server.
void	stop() Stop the server.
String	toString() Get String repesentation.

Methods inherited from class java.lang.Object

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

Field Detail

VARNAME_COAP_EXCHANGE

public static final String VARNAME_COAP_EXCHANGE

The name of the CoapExchange variable.

See Also:

Constant Field Values

VARNAME_DEFAULT_RESPONSE_CODE

public static final String VARNAME_DEFAULT_RESPONSE_CODE

The name of the default response code variable.

See Also:

Constant Field Values

notifyOnShutdown

@Parameter
 @Optional(defaultValue="true")
 @Summary(value="Notify observing clients of server shutdown. \nWhen true observing clients are notified by Not-Found notifications. \nDefault value is 100 ms.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
 @DisplayName(value="Notify observing clients on shutdown")
 @Placement(order=1,
           tab="Advanced")
public boolean notifyOnShutdown

Notify observing clients of server shutdown. When true observing clients are notified by Not-Found notifications. Default value is true.

lingerOnShutdown

@Parameter
 @Optional(defaultValue="250")
 @Summary(value="The linger time (in milliseconds [ms]) on shutdown of the server, \ngiving notifications time to complete. \nDefault value is 250 ms.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
 @Placement(order=2,
           tab="Advanced")
public long lingerOnShutdown

The linger time (in milliseconds [ms]) on shutdown of the server, giving notifications time to complete. Default value is 250 ms.

Constructor Detail

Server

public Server()

Method Detail

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

dispose

public void dispose()

Dispose of the server. Endpoints will be disconnected and cleaned up when needed.

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Start the server. When started the server will accept requests.

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Throws:

org.mule.runtime.api.exception.MuleException

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Stop the server. All resources of the server will be removed and observing clients will be notified of this. After

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException

getServerName

public String getServerName()

Returns:

the serverName

getRegistry

public ResourceRegistry getRegistry()

Returns:

the registry

getResources

public List<ResourceConfig> getResources()

Returns:

the resources

setResources

public void setResources(List<ResourceConfig> resources)

Parameters:

resources - the resources to set

getAdditionalEndpoints

public List<AdditionalEndpoint> getAdditionalEndpoints()

Returns:

the endpointRefs of the server.

setAdditionalEndpoints

public void setAdditionalEndpoints(List<AdditionalEndpoint> endpoints)

Parameters:

endpoints - the endpoints references to set.

getSchedulerService

public org.mule.runtime.api.scheduler.SchedulerService getSchedulerService()

Returns:

the schedulerService

getSchedulerConfig

public org.mule.runtime.api.scheduler.SchedulerConfig getSchedulerConfig()

Returns:

the schedulerConfig

toString

public String toString()

Get String repesentation.

Overrides:

toString in class Object