ch.ethz.inf.vs.californium.osgi

Class ManagedServer

java.lang.Object

ch.ethz.inf.vs.californium.osgi.ManagedServer

All Implemented Interfaces:

ServerEndpointRegistry, org.osgi.service.cm.ManagedService, org.osgi.util.tracker.ServiceTrackerCustomizer<Resource,Resource>

public class ManagedServer
extends Object
implements org.osgi.service.cm.ManagedService, org.osgi.util.tracker.ServiceTrackerCustomizer<Resource,Resource>, ServerEndpointRegistry

A managed Californium ServerInterface instance that can be configured using the OSGi Configuration Admin service. The service understands all network configuration properties defined by NetworkConfigDefaults. In particular, it uses the following properties to determine which endpoints the managed server should listen on:

• DEFAULT_COAP_PORT - The port to bind the default CoAP endpoint (non-secure) to.
• DEFAULT_COAPS_PORT - The port to bind an (optional) secure (DTLS) endpoint to. In order for this to work, the EndpointFactory provided via the constructor must support the creation of secure endpoints.

This managed service uses the white board pattern for registering resources, i.e. the service tracks Californium Resource instances being added to the OSGi service registry and automatically adds them to the managed Californium ServerInterface instance.

Author:

Kai Hudalla

Constructor Summary

Constructors

Constructor and Description
ManagedServer(org.osgi.framework.BundleContext bundleContext, EndpointFactory endpointFactory) Sets all required collaborators.
ManagedServer(org.osgi.framework.BundleContext bundleContext, ch.ethz.inf.vs.californium.osgi.ServerInterfaceFactory serverFactory, EndpointFactory endpointFactory) Sets all required collaborators.

Method Summary

Methods

Modifier and Type	Method and Description
Resource	addingService(org.osgi.framework.ServiceReference<Resource> reference) Adds a Californium Resource to the managed Californium Server.
Endpoint	getEndpoint(InetSocketAddress address) Gets the endpoint bound to a particular address.
Endpoint	getEndpoint(int port) Gets the endpoint bound to a particular port.
void	modifiedService(org.osgi.framework.ServiceReference<Resource> reference, Resource service) Does nothing as the Californium server does not need to be informed about updated service registration properties of a Resource.
void	removedService(org.osgi.framework.ServiceReference<Resource> reference, Resource service) Removes a Californium Resource from the managed Californium Server.
void	stop() Stops and destroys the managed server instance.
void	updated(Dictionary<String,?> properties) Updates the configuration properties of the wrapped Californium server.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedServer

public ManagedServer(org.osgi.framework.BundleContext bundleContext,
             EndpointFactory endpointFactory)

Sets all required collaborators. Invoking this constructor is equivalent to invoking ManagedServer(BundleContext, EndpointFactory) with null as the server factory.

Parameters:

bundleContext - the bundle context to be used for tracking Resources

endpointFactory - the factory to use for creating endpoints for the managed server

Throws:

NullPointerException - if any of the parameters is null

ManagedServer

public ManagedServer(org.osgi.framework.BundleContext bundleContext,
             ch.ethz.inf.vs.californium.osgi.ServerInterfaceFactory serverFactory,
             EndpointFactory endpointFactory)

Sets all required collaborators.

Parameters:

bundleContext - the bundle context to be used for tracking Resources

serverFactory - the factory to use for creating new server instances

endpointFactory - the factory to use for creating endpoints for the managed server

Throws:

NullPointerException - if the bundle context is null

Method Detail

updated

public void updated(Dictionary<String,?> properties)
             throws org.osgi.service.cm.ConfigurationException

Updates the configuration properties of the wrapped Californium server. If the server is running when this method is called by ConfigAdmin, the server is destroyed, a new instance is created using the given properties and finally started.

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Parameters:

properties - the properties to set on the server

Throws:

org.osgi.service.cm.ConfigurationException

stop

public void stop()

Stops and destroys the managed server instance. This method should be called by the BundleActivator that registered this managed service when the bundle is stopped.

addingService

public Resource addingService(org.osgi.framework.ServiceReference<Resource> reference)

Adds a Californium Resource to the managed Californium Server. This method is invoked automatically by the ServiceTracker whenever a Resource is added to the OSGi service registry.

Specified by:

addingService in interface org.osgi.util.tracker.ServiceTrackerCustomizer<Resource,Resource>

Parameters:

reference - the Resource service that has been added

Returns:

the unmodified Resource

removedService

public void removedService(org.osgi.framework.ServiceReference<Resource> reference,
                  Resource service)

Removes a Californium Resource from the managed Californium Server. This method is invoked automatically by the ServiceTracker whenever a Resource is removed from the OSGi service registry.

Specified by:

removedService in interface org.osgi.util.tracker.ServiceTrackerCustomizer<Resource,Resource>

Parameters:

reference - the reference to the Resource service that has been removed

service - the service object

modifiedService

public void modifiedService(org.osgi.framework.ServiceReference<Resource> reference,
                   Resource service)

Does nothing as the Californium server does not need to be informed about updated service registration properties of a Resource.

Specified by:

modifiedService in interface org.osgi.util.tracker.ServiceTrackerCustomizer<Resource,Resource>

Parameters:

reference - the updated Resource service reference

service - the corresponding Resource instance

getEndpoint

public Endpoint getEndpoint(InetSocketAddress address)

Description copied from interface: ServerEndpointRegistry

Gets the endpoint bound to a particular address.

Specified by:

getEndpoint in interface ServerEndpointRegistry

Parameters:

address - the address

Returns:

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

getEndpoint

public Endpoint getEndpoint(int port)

Description copied from interface: ServerEndpointRegistry

Gets the endpoint bound to a particular port.

Specified by:

getEndpoint in interface ServerEndpointRegistry

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