org.opendaylight.controller.config.api.annotations

Annotation Type ServiceInterfaceAnnotation

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface ServiceInterfaceAnnotation

Marks an interface implemented by Module as a Service Interface. Each service interface is identified by globally unique and human readable name. By convention the name is all lower case without spaces.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	localName Get local name of value().
String	namespace Get namespace of value().
Class<?>	osgiRegistrationType Mandatory class which will be used as key for OSGi service registration once Module.getInstance() is called.
String	revision Get revision of value().
String	value Fully qualified name of a service that must be globally unique.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	registerToOsgi Determines whether or not the service instance should be registered with OSGi.

Element Detail

value

public abstract String value

Fully qualified name of a service that must be globally unique. When generating service interfaces from yang, this will be QName of identity extending service-type.

osgiRegistrationType

public abstract Class<?> osgiRegistrationType

Mandatory class which will be used as key for OSGi service registration once Module.getInstance() is called.

namespace

public abstract String namespace

Get namespace of value().

revision

public abstract String revision

Get revision of value().

localName

public abstract String localName

Get local name of value().

registerToOsgi

public abstract boolean registerToOsgi

Determines whether or not the service instance should be registered with OSGi.

Default:

true