Package de.dytanic.cloudnet.driver.provider.service

Interface GeneralCloudServiceProvider

  • public interface GeneralCloudServiceProvider
    This class provides methods to get information to the services in the cluster.

    • Method Detail

      • getServicesAsUniqueId

        java.util.Collection<java.util.UUID> getServicesAsUniqueId()
        Gets a list with the uniqueIds of all services in the cloud
        Returns:
        a list containing the uniqueIds of every service in the whole cloud

      • getCloudServices

        java.util.Collection<ServiceInfoSnapshot> getCloudServices()
        Gets a list with the infos of all services in the cloud
        Returns:
        a list containing the infos of every service in the whole cloud

      • getStartedCloudServices

        java.util.Collection<ServiceInfoSnapshot> getStartedCloudServices()
        Gets a list with the infos of all started services in the cloud
        Returns:
        a list containing the infos of every started service in the whole cloud

      • getCloudServices

        java.util.Collection<ServiceInfoSnapshot> getCloudServices​(@NotNull
                                                           @NotNull java.lang.String taskName)
        Gets a list with the infos of all services in the cloud that are from the given task
        Parameters:
        taskName - the case-insensitive name of the task every service in the list should have
        Returns:
        a list containing the infos of every service with the given task in the whole cloud

      • getCloudServices

        java.util.Collection<ServiceInfoSnapshot> getCloudServices​(@NotNull
                                                           @NotNull ServiceEnvironmentType environment)
        Gets a list with the infos of all services in the cloud that have the given environment
        Parameters:
        environment - the environment every service in the list should have
        Returns:
        a list containing the infos of every service with the given environment in the whole cloud

      • getCloudServicesByGroup

        java.util.Collection<ServiceInfoSnapshot> getCloudServicesByGroup​(@NotNull
                                                                  @NotNull java.lang.String group)
        Gets a list with the infos of all services in the cloud that have the given group
        Parameters:
        group - the case-insensitive name of the task every service in the list should have
        Returns:
        a list containing the infos of every service with the given group in the whole cloud

      • getServicesCount

        int getServicesCount()
        Gets the amount of services in the cloud
        Returns:
        an integer for the amount of services in the whole cloud

      • getServicesCountByGroup

        int getServicesCountByGroup​(@NotNull
                            @NotNull java.lang.String group)
        Gets the amount of services by the given group in the cloud
        Parameters:
        group - the group every service counting should have
        Returns:
        an integer for the amount of services in the whole cloud

      • getServicesCountByTask

        int getServicesCountByTask​(@NotNull
                           @NotNull java.lang.String taskName)
        Gets the amount of services by the given task in the cloud
        Parameters:
        taskName - the task every service counting should have
        Returns:
        an integer for the amount of services in the whole cloud

      • getCloudServiceByName

        @Nullable
@Nullable ServiceInfoSnapshot getCloudServiceByName​(@NotNull
                                                    @NotNull java.lang.String name)
        Gets the info of a cloud service by its name
        Parameters:
        name - the name of the service
        Returns:
        the info of the service or null if the service doesn't exist

      • getCloudService

        @Nullable
@Nullable ServiceInfoSnapshot getCloudService​(@NotNull
                                              @NotNull java.util.UUID uniqueId)
        Gets the info of a cloud service by its uniqueId
        Parameters:
        uniqueId - the uniqueId of the service
        Returns:
        the info of the service or null if the service doesn't exist

      • getServicesAsUniqueIdAsync

        @NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Collection<java.util.UUID>> getServicesAsUniqueIdAsync()
        Gets a list with the uniqueIds of all services in the cloud
        Returns:
        a list containing the uniqueIds of every service in the whole cloud

      • getCloudServicesAsync

        @NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Collection<ServiceInfoSnapshot>> getCloudServicesAsync()
        Gets a list with the infos of all services in the cloud
        Returns:
        a list containing the infos of every service in the whole cloud

      • getStartedCloudServicesAsync

        @NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Collection<ServiceInfoSnapshot>> getStartedCloudServicesAsync()
        Gets a list with the infos of all started services in the cloud
        Returns:
        a list containing the infos of every started service in the whole cloud

      • getCloudServicesAsync

        @NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Collection<ServiceInfoSnapshot>> getCloudServicesAsync​(@NotNull
                                                                                                                      @NotNull java.lang.String taskName)
        Gets a list with the infos of all services in the cloud that are from the given task
        Parameters:
        taskName - the name of the task every service in the list should have
        Returns:
        a list containing the infos of every service with the given task in the whole cloud

      • getCloudServicesAsync

        @NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Collection<ServiceInfoSnapshot>> getCloudServicesAsync​(@NotNull
                                                                                                                      @NotNull ServiceEnvironmentType environment)
        Gets a list with the infos of all services in the cloud that have the given environment
        Parameters:
        environment - the environment every service in the list should have
        Returns:
        a list containing the infos of every service with the given environment in the whole cloud

      • getCloudServicesByGroupAsync

        @NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.util.Collection<ServiceInfoSnapshot>> getCloudServicesByGroupAsync​(@NotNull
                                                                                                                             @NotNull java.lang.String group)
        Gets a list with the infos of all services in the cloud that have the given group
        Parameters:
        group - the name of the task every service in the list should have
        Returns:
        a list containing the infos of every service with the given group in the whole cloud

      • getServicesCountAsync

        @NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Integer> getServicesCountAsync()
        Gets the amount of services in the cloud
        Returns:
        an integer for the amount of services in the whole cloud

      • getServicesCountByGroupAsync

        @NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Integer> getServicesCountByGroupAsync​(@NotNull
                                                                                                     @NotNull java.lang.String group)
        Gets the amount of services by the given group in the cloud
        Parameters:
        group - the group every service counting should have
        Returns:
        an integer for the amount of services in the whole cloud

      • getServicesCountByTaskAsync

        @NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<java.lang.Integer> getServicesCountByTaskAsync​(@NotNull
                                                                                                    @NotNull java.lang.String taskName)
        Gets the amount of services by the given task in the cloud
        Parameters:
        taskName - the task every service counting should have
        Returns:
        an integer for the amount of services in the whole cloud

      • getCloudServiceByNameAsync

        @NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<ServiceInfoSnapshot> getCloudServiceByNameAsync​(@NotNull
                                                                                                     @NotNull java.lang.String name)
        Gets the info of a cloud service by its name
        Parameters:
        name - the name of the service
        Returns:
        the info of the service or null if the service doesn't exist

      • getCloudServiceAsync

        @NotNull
@NotNull de.dytanic.cloudnet.common.concurrent.ITask<ServiceInfoSnapshot> getCloudServiceAsync​(@NotNull
                                                                                               @NotNull java.util.UUID uniqueId)
        Gets the info of a cloud service by its uniqueId
        Parameters:
        uniqueId - the uniqueId of the service
        Returns:
        the info of the service or null if the service doesn't exist