public interface

ServerInstance

com.microstrategy.web.objects.admin.serverconfig.ServerInstance
Known Indirect Subclasses

Class Overview

The ServerInstance interface represents the properties of a single server instance. It contains methods to modify the state of the server, such as start, stop, and terminate. In addition, it has methods to obtain the status of the instance and the service configuration of the instance. In addition, depending upon the server type, this object can be cast into a type-specific interface; for example, an instance of type EnumServerTypes.IntelligenceServer can be cast into the IntelligenceServerInstance interface to access type-specific methods.

Also, note that any changes to the specific interface's properties or the ServiceConfiguration interface will not take place until the save method is called. The save method will cause any changes to the instance to be submitted to the server.

Summary

Public Methods
abstract ServerLicense getLicense()
Returns an ServerLicense object which describes the features of the server license
abstract String getName()
Returns the name of the server instance.
abstract int getServerType()
Returns type type of server that the server instance refers to, from EnumServerTypes.
abstract ServiceConfiguration getServiceConfiguration()
Returns the service configuration of a ServerInstance object which is registered as a service.
abstract InstanceStatus getStatus()
Returns an InstanceStatus object which describes the status of the server instance.
abstract boolean isService()
Returns whether the instance is registered as a service on the server machine.
abstract void pause()
Attempts to pause the server instance on the server machine.
abstract void registerService()
Registers the instance as a service.
abstract void resume()
Attempts to resume the server instance on the server machine.
abstract void save()
Saves any changes made to either the type-specific properties of this object or the ServiceConfiguration object available from the getServiceConfiguration method.
abstract void start()
Attempts to start the server instance on the given server machine.
abstract void start(boolean isService)
Attempts to start the server instance on the given server machine.
abstract void stop()
Attempts to stop the server instance on the server machine.
abstract void terminate()
Attempts to terminate the server instance on the server machine.
abstract void unregisterService()
Unregisters the instance as a service.

Public Methods

public abstract ServerLicense getLicense ()

Returns an ServerLicense object which describes the features of the server license

Returns
  • A value from ServerLicense which describes the features of the server license

public abstract String getName ()

Returns the name of the server instance.

Returns
  • The name of the server instance.

public abstract int getServerType ()

Returns type type of server that the server instance refers to, from EnumServerTypes.

Returns

public abstract ServiceConfiguration getServiceConfiguration ()

Returns the service configuration of a ServerInstance object which is registered as a service. This method should only be called if the isService method returns true; if it returns false, then this method will fail.

Returns
Throws
ServerConfigException Thrown if an error occurs when retrieving the service configuration information.

public abstract InstanceStatus getStatus ()

Returns an InstanceStatus object which describes the status of the server instance.

Returns
Throws
ServerConfigException Thrown if the status cannot be obtained.

public abstract boolean isService ()

Returns whether the instance is registered as a service on the server machine. This is set upon creation of the server instance, and cannot be changed after creation.

Returns
  • True if the instance is registered as a service, false otherwise.
Throws
ServerConfigException Thrown if an error occurs when obtaining whether the instance is a service.

public abstract void pause ()

Attempts to pause the server instance on the server machine.

Throws
ServerConfigException Thrown if an error occurs.

public abstract void registerService ()

Registers the instance as a service. Note that this will only work when called on an instance which is not already registered as a service, and will take place immediately.

Throws
ServerConfigException Thrown if an error occurs.

public abstract void resume ()

Attempts to resume the server instance on the server machine.

Throws
ServerConfigException Thrown if an error occurs.

public abstract void save ()

Saves any changes made to either the type-specific properties of this object or the ServiceConfiguration object available from the getServiceConfiguration method.

Throws
ServerConfigException Thrown if an error occurs when saving the changes.

public abstract void start ()

Attempts to start the server instance on the given server machine. Note that if this method, as opposed to the method containing the isService flag, is called, then the instance will be started as a service if it is registered, or interactively if it is not registered.

Throws
ServerConfigException Thrown if an error occurs.

public abstract void start (boolean isService)

Attempts to start the server instance on the given server machine.

Parameters
isService Whether to start the instance as a service or interactively.
Throws
ServerConfigException Thrown if an error occurs.

public abstract void stop ()

Attempts to stop the server instance on the server machine.

Throws
ServerConfigException Thrown if an error occurs.

public abstract void terminate ()

Attempts to terminate the server instance on the server machine.

Throws
ServerConfigException Thrown if an error occurs.

public abstract void unregisterService ()

Unregisters the instance as a service. Note that this will only work when called on an instance which is already registered as a service, and will take place immediately.

Throws
ServerConfigException Thrown if an error occurs.