org.eclipse.californium.core.server

Interface ServerInterface

All Known Implementing Classes:

CoAPLDPServer, CoAPLDPTestSuiteServer, CoapServer

public interface ServerInterface

An execution environment for CoAP Resources. A server hosts a tree of Resources which are exposed to clients by means of one or more Endpoints which are bound to a network interface. Resources can be added and removed from the server dynamically during runtime. The server starts to process incoming CoAP requests after its start() method has been invoked and does so until it is stopped again via its stop() method.

Method Summary

Modifier and Type	Method and Description
ServerInterface	add(Resource... resources) Adds one or more resources to the server.
void	addEndpoint(Endpoint endpoint) Adds an endpoint for receive and sending CoAP messages on.
void	destroy() Destroys the server, i.e. unbinds from all ports and frees all system resources.
Endpoint	getEndpoint(java.net.InetSocketAddress address) Gets the endpoint bound to a particular address.
Endpoint	getEndpoint(int port) Gets an endpoint bound to a particular port.
java.util.List<Endpoint>	getEndpoints() Gets the endpoints this server is bound to.
boolean	remove(Resource resource) Removes a resource from the server.
void	start() Starts the server by starting all endpoints this server is assigned to.
void	stop() Stops the server, i.e. unbinds it from all ports.

Method Detail

start

void start()

Starts the server by starting all endpoints this server is assigned to. Each endpoint binds to its port. If no endpoint is assigned to the server, the server binds to CoAP's default port 5683. Implementations should start all registered endpoints as part of this method.

Throws:

java.lang.IllegalStateException - if the server could not be started properly, e.g. because none of its endpoints could be bound to their respective ports

stop

void stop()

Stops the server, i.e. unbinds it from all ports. Frees as much system resources as possible while still being able to be started again. Implementations should stop all registered endpoints as part of this method.

destroy

void destroy()

Destroys the server, i.e. unbinds from all ports and frees all system resources. The server instance is not expected to be able to be started again once this method has been invoked.

add

ServerInterface add(Resource... resources)

Adds one or more resources to the server.

Parameters:

resources - the resources

Returns:

the server

remove

boolean remove(Resource resource)

Removes a resource from the server.

Parameters:

resource - the resource to be removed

Returns:

true if the resource has been removed successfully

addEndpoint

void addEndpoint(Endpoint endpoint)

Adds an endpoint for receive and sending CoAP messages on.

Parameters:

endpoint - the endpoint

Throws:

java.lang.NullPointerException - if the endpoint is null

getEndpoints

java.util.List<Endpoint> getEndpoints()

Gets the endpoints this server is bound to.

Returns:

the endpoints

getEndpoint

Endpoint getEndpoint(java.net.InetSocketAddress address)

Gets the endpoint bound to a particular address.

Parameters:

address - the address

Returns:

the endpoint or null if none of the server's endpoints is bound to the given address

getEndpoint

Endpoint getEndpoint(int port)

Gets an endpoint bound to a particular port. If the server has multiple endpoints on different network interfaces bound to the same port, an implementation may return any of those endpoints.

Parameters:

port - the port

Returns:

the endpoint or null if none of the server's endpoints is bound to the given port on any of its network interfaces