Package org.onosproject.app

Class DefaultApplicationDescription

java.lang.Object

org.onosproject.app.DefaultApplicationDescription

All Implemented Interfaces:

ApplicationDescription

public final class DefaultApplicationDescription
extends Object
implements ApplicationDescription

Default implementation of network control/management application descriptor.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultApplicationDescription.Builder	Default application description builder.

Method Summary

Modifier and Type	Method	Description
static DefaultApplicationDescription.Builder	builder()	Returns a default application description builder.
String	category()	Returns category of the application.
String	description()	Returns description of the application.
List<String>	features()	Returns the list of features comprising the application.
Optional<URI>	featuresRepo()	Returns the feature repository URI.
byte[]	icon()	Returns icon of the application.
String	name()	Returns the application name id.
String	origin()	Returns the name of the application origin, group or company.
Set<Permission>	permissions()	Returns the permissions requested by the application.
String	readme()	Returns readme of the application.
List<String>	requiredApps()	Returns list of required application names.
ApplicationRole	role()	Returns the role of the application.
String	title()	Returns title of the application.
String	toString()
String	url()	Returns url of the application.
Version	version()	Returns the application version.

Methods inherited from class java.lang.Object

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

Method Detail

name

public String name()

Description copied from interface: ApplicationDescription

Returns the application name id.

Specified by:

name in interface ApplicationDescription

Returns:

application identifier

version

public Version version()

Description copied from interface: ApplicationDescription

Returns the application version.

Specified by:

version in interface ApplicationDescription

Returns:

application version

title

public String title()

Description copied from interface: ApplicationDescription

Returns title of the application.

Specified by:

title in interface ApplicationDescription

Returns:

application title text

description

public String description()

Description copied from interface: ApplicationDescription

Returns description of the application.

Specified by:

description in interface ApplicationDescription

Returns:

application description text

category

public String category()

Description copied from interface: ApplicationDescription

Returns category of the application. The application developer can choose one of the category from the following examples to easily discern the high-level purpose of the application. (Security, Traffic Steering, Monitoring, Drivers, Provider, Utility)

Specified by:

category in interface ApplicationDescription

Returns:

application category text

url

public String url()

Description copied from interface: ApplicationDescription

Returns url of the application.

Specified by:

url in interface ApplicationDescription

Returns:

application url

readme

public String readme()

Description copied from interface: ApplicationDescription

Returns readme of the application.

Specified by:

readme in interface ApplicationDescription

Returns:

application readme

icon

public byte[] icon()

Description copied from interface: ApplicationDescription

Returns icon of the application.

Specified by:

icon in interface ApplicationDescription

Returns:

application icon

origin

public String origin()

Description copied from interface: ApplicationDescription

Returns the name of the application origin, group or company.

Specified by:

origin in interface ApplicationDescription

Returns:

application origin

role

public ApplicationRole role()

Description copied from interface: ApplicationDescription

Returns the role of the application.

Specified by:

role in interface ApplicationDescription

Returns:

application role

permissions

public Set<Permission> permissions()

Description copied from interface: ApplicationDescription

Returns the permissions requested by the application.

Specified by:

permissions in interface ApplicationDescription

Returns:

requested permissions

featuresRepo

public Optional<URI> featuresRepo()

Description copied from interface: ApplicationDescription

Returns the feature repository URI. Null value signifies that the application did not provide its own features repository.

Specified by:

featuresRepo in interface ApplicationDescription

Returns:

optional feature repo URL

features

public List<String> features()

Description copied from interface: ApplicationDescription

Returns the list of features comprising the application. At least one feature must be given.

Specified by:

features in interface ApplicationDescription

Returns:

application features

requiredApps

public List<String> requiredApps()

Description copied from interface: ApplicationDescription

Returns list of required application names.

Specified by:

requiredApps in interface ApplicationDescription

Returns:

list of application names

toString

public String toString()

Overrides:

toString in class Object

builder

public static DefaultApplicationDescription.Builder builder()

Returns a default application description builder.

Returns:

builder