Package org.onosproject.app

Interface ApplicationDescription

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

    • Method Detail

      • name

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

      • version

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

      • origin

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

      • title

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

      • description

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

      • category

        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

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

      • readme

        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

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

      • featuresRepo

        Optional<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

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

      • requiredApps

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