Package org.onosproject.app

Interface ApplicationDescription

  • All Known Implementing Classes:
    DefaultApplicationDescription
    public interface ApplicationDescription
    Description of a network control/management application.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String category()
      Returns category of the application.
      java.lang.String description()
      Returns description of the application.
      java.util.List<java.lang.String> features()
      Returns the list of features comprising the application.
      java.util.Optional<java.net.URI> featuresRepo()
      Returns the feature repository URI.
      byte[] icon()
      Returns icon of the application.
      java.lang.String name()
      Returns the application name id.
      java.lang.String origin()
      Returns the name of the application origin, group or company.
      java.util.Set<Permission> permissions()
      Returns the permissions requested by the application.
      java.lang.String readme()
      Returns readme of the application.
      java.util.List<java.lang.String> requiredApps()
      Returns list of required application names.
      ApplicationRole role()
      Returns the role of the application.
      java.lang.String title()
      Returns title of the application.
      java.lang.String url()
      Returns url of the application.
      Version version()
      Returns the application version.

    • Method Detail

      • name

        java.lang.String name()
        Returns the application name id.
        Returns:
        application identifier

      • version

        Version version()
        Returns the application version.
        Returns:
        application version

      • origin

        java.lang.String origin()
        Returns the name of the application origin, group or company.
        Returns:
        application origin

      • title

        java.lang.String title()
        Returns title of the application.
        Returns:
        application title text

      • description

        java.lang.String description()
        Returns description of the application.
        Returns:
        application description text

      • category

        java.lang.String category()
        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)
        Returns:
        application category text

      • url

        java.lang.String url()
        Returns url of the application.
        Returns:
        application url

      • readme

        java.lang.String readme()
        Returns readme of the application.
        Returns:
        application readme

      • icon

        byte[] icon()
        Returns icon of the application.
        Returns:
        application icon

      • role

        ApplicationRole role()
        Returns the role of the application.
        Returns:
        application role

      • permissions

        java.util.Set<Permission> permissions()
        Returns the permissions requested by the application.
        Returns:
        requested permissions

      • featuresRepo

        java.util.Optional<java.net.URI> featuresRepo()
        Returns the feature repository URI. Null value signifies that the application did not provide its own features repository.
        Returns:
        optional feature repo URL

      • features

        java.util.List<java.lang.String> features()
        Returns the list of features comprising the application. At least one feature must be given.
        Returns:
        application features

      • requiredApps

        java.util.List<java.lang.String> requiredApps()
        Returns list of required application names.
        Returns:
        list of application names