Package com.microstrategy.web.objects.admin.serverconfig

Interface ServiceConfiguration

  • public interface ServiceConfiguration
    This interface represents the configuration of a server instance which is configured as a service. This interface is obtained from the ServerInstance interface, and changes made to the properties on this interface will only be saved upon calling the save method on the ServerInstance interface.
    Since:
    MicroStrategy Web 7.5.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDefaultLogin()
      Returns the default service login for this system, if one exists.
      java.lang.String getLogin()
      Returns the login which is currently configured as the credentials for the service to run as.
      int getMode()
      Returns the mode of the service, from EnumServiceMode.
      boolean isLoginModifiable()
      Returns whether the login is modifiable for this type of system.
      boolean isPasswordRequired()
      Returns whether a password is required for the service login on this type of system.
      boolean isRestarterEnabled()
      Returns whether the restarter is enabled for this service.
      void setConfiguration​(int mode)
      Sets the mode of the service.
      void setConfiguration​(java.lang.String l, java.lang.String p)
      Sets the configuration of the service.
      void setConfiguration​(java.lang.String l, java.lang.String p, int mode)
      Sets the configuration of the service.
      void setRestarterEnabled​(boolean isEnabled)
      Sets whether the restarter should be enabled for this service.
      boolean supportsMode​(int serviceMode)
      Returns whether the given mode is supported on this system.

    • Method Detail

      • getLogin

        java.lang.String getLogin()
        Returns the login which is currently configured as the credentials for the service to run as.
        Returns:
        the login which will be used as the credentials for the service.

      • setConfiguration

        void setConfiguration​(java.lang.String l,
                      java.lang.String p)
        Sets the configuration of the service. This method will change the credentials used, but not the mode. This change will not be applied until the save method is called on the ServerInstance object which this object came from.
        Parameters:
        l - The login to use for the service.
        p - The password to use for the service.

      • setConfiguration

        void setConfiguration​(java.lang.String l,
                      java.lang.String p,
                      int mode)
        Sets the configuration of the service. This method will change the credentials used and the mode. This change will not be applied until the save method is called on the ServerInstance object which this object came from.
        Parameters:
        l - The login to use for the service.
        p - The password to use for the service.
        mode - The mode that the service should be set to, from EnumServiceMode.

      • setConfiguration

        void setConfiguration​(int mode)
        Sets the mode of the service. This change will not be applied until the save method is called on the ServerInstance object which this object came from.
        Parameters:
        mode - The mode that the service should be set to, from EnumServiceMode.

      • isRestarterEnabled

        boolean isRestarterEnabled()
        Returns whether the restarter is enabled for this service.
        Returns:
        True if the restarter is enabled, false otherwise.

      • setRestarterEnabled

        void setRestarterEnabled​(boolean isEnabled)
        Sets whether the restarter should be enabled for this service.
        Parameters:
        isEnabled - The desired state of the restarter.

      • isLoginModifiable

        boolean isLoginModifiable()
        Returns whether the login is modifiable for this type of system.
        Returns:
        Whether the login is modifiable on this system.
        Since:
        MicroStrategy Web 7.5.2

      • getDefaultLogin

        java.lang.String getDefaultLogin()
        Returns the default service login for this system, if one exists. If one does not exist, this method will return null or empty string.
        Returns:
        The default service login for this system, if one exists.
        Since:
        MicroStrategy Web 7.5.2

      • isPasswordRequired

        boolean isPasswordRequired()
        Returns whether a password is required for the service login on this type of system.
        Returns:
        Whether a password is required for the service login on the system.
        Since:
        MicroStrategy Web 7.5.2

      • supportsMode

        boolean supportsMode​(int serviceMode)
        Returns whether the given mode is supported on this system.
        Parameters:
        serviceMode - The service mode to check.
        Returns:
        True if the service mode is supported, false otherwise.
        Since:
        MicroStrategy Web 7.5.2