Package org.nuxeo.targetplatforms.api.service

Interface TargetPlatformService

All Known Implementing Classes:
TargetPlatformServiceImpl
public interface TargetPlatformService
Service for target platforms and packages management.
Since:
5.7.1

  • Method Details

    • getOverrideDirectory

      String getOverrideDirectory()
      Returns the override directory name.

    • getDefaultTargetPlatform

      TargetPlatform getDefaultTargetPlatform(TargetPlatformFilter filter)
      Returns the default target platform.

      If several target platforms are found for given filter, the first one is returned (ordered alphabetically on id).

    • getTargetPlatform

      TargetPlatform getTargetPlatform(String id)
      Returns the target platform with given id, or null if not found.

    • getTargetPlatformInfo

      TargetPlatformInfo getTargetPlatformInfo(String id)
      Returns the target platform info for given id, or null if not found.

    • getTargetPackage

      TargetPackage getTargetPackage(String id)
      Returns the target package with given id, or null if not found.

    • getTargetPackageInfo

      TargetPackageInfo getTargetPackageInfo(String id)
      Returns the target package info for given id, or null if not found.

    • getTargetPlatformInstance

      TargetPlatformInstance getTargetPlatformInstance(String id, List<String> packages)
      Returns a target platform instance with given id and given enabled packages, or null if not found.

      Ignore target packages that would not be found.

    • getAvailableTargetPlatforms

      List<TargetPlatform> getAvailableTargetPlatforms(TargetPlatformFilter filter)
      Returns all target platforms matching given criteria.
      Parameters:
      filter - the filter to apply, can be null if no filtering is needed.
      See Also:

    • getAvailableTargetPlatformsInfo

      List<TargetPlatformInfo> getAvailableTargetPlatformsInfo(TargetPlatformFilter filter)
      Returns all target platforms info matching given criteria.
      Parameters:
      filter - the filter to apply, can be null if no filtering is needed.
      See Also:

    • deprecateTargetPlatform

      void deprecateTargetPlatform(boolean deprecate, String id)
      Deprecates the target platform if given boolean is true (or un-deprecates it if boolean is false), overriding the default value from extension points and adding an entry in the override directory.

    • enableTargetPlatform

      void enableTargetPlatform(boolean enable, String id)
      Enables the target platform if given boolean is true (or disables it boolean is false), overriding the default value from extension points and adding an entry in the override directory.

    • restrictTargetPlatform

      void restrictTargetPlatform(boolean restrict, String id)
      Restricts the target platform if given boolean is true (or un-restricts it if boolean is false), overriding the default value from extension points and adding an entry in the override directory.

    • setTrialTargetPlatform

      void setTrialTargetPlatform(boolean trial, String id)
      Set the target platform as trial if given boolean is true (or unset it as trial if boolean is false), overriding the default value from extension points and adding an entry in the override directory.

    • setDefaultTargetPlatform

      void setDefaultTargetPlatform(boolean isDefault, String id)
      Set the target platform as default if given boolean is true (or unset it as default if boolean is false), overriding the default value from extension points and adding an entry in the override directory.

    • restoreTargetPlatform

      void restoreTargetPlatform(String id)
      Removes overrides for this target platform.

    • restoreAllTargetPlatforms

      void restoreAllTargetPlatforms()
      Removes overrides for all target platform.

    • getDefaultTargetPlatformInstance

      TargetPlatformInstance getDefaultTargetPlatformInstance(boolean restricted)
      Returns:
      the default target platform instance and enabled if not found.
      Since:
      5.9.3-NXP-15602