public interface

ServiceConfiguration

com.microstrategy.web.objects.admin.serverconfig.ServiceConfiguration

Class Overview

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.

Summary

Public Methods
abstract String getDefaultLogin()
Returns the default service login for this system, if one exists.
abstract String getLogin()
Returns the login which is currently configured as the credentials for the service to run as.
abstract int getMode()
Returns the mode of the service, from EnumServiceMode.
abstract boolean isLoginModifiable()
Returns whether the login is modifiable for this type of system.
abstract boolean isPasswordRequired()
Returns whether a password is required for the service login on this type of system.
abstract boolean isRestarterEnabled()
Returns whether the restarter is enabled for this service.
abstract void setConfiguration(int mode)
Sets the mode of the service.
abstract void setConfiguration(String login, String password)
Sets the configuration of the service.
abstract void setConfiguration(String login, String password, int mode)
Sets the configuration of the service.
abstract void setRestarterEnabled(boolean isEnabled)
Sets whether the restarter should be enabled for this service.
abstract boolean supportsMode(int serviceMode)
Returns whether the given mode is supported on this system.

Public Methods

public abstract 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.

public abstract 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.

public abstract int getMode ()

Returns the mode of the service, from EnumServiceMode.

Returns

public abstract boolean isLoginModifiable ()

Returns whether the login is modifiable for this type of system.

Returns
  • Whether the login is modifiable on this system.

public abstract 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.

public abstract boolean isRestarterEnabled ()

Returns whether the restarter is enabled for this service.

Returns
  • True if the restarter is enabled, false otherwise.

public abstract 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.

public abstract void setConfiguration (String login, String password)

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
login The login to use for the service.
password The password to use for the service.

public abstract void setConfiguration (String login, String password, 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
login The login to use for the service.
password The password to use for the service.
mode The mode that the service should be set to, from EnumServiceMode.

public abstract void setRestarterEnabled (boolean isEnabled)

Sets whether the restarter should be enabled for this service.

Parameters
isEnabled The desired state of the restarter.

public abstract 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.