public abstract class

ServerControlSource

extends Object
java.lang.Object
   ↳ com.microstrategy.web.objects.admin.serverconfig.ServerControlSource

Class Overview

The ServerControlSource interface represents the entry point for the Server Control-related functionality. It contains a static method to obtain a new instance, which is the entry point for the API. Note that after using the API, it is recommended, though not required, to call the release method. This will cause the underlying C++ object to be released; this will increase the efficiency of the API's memory usage, as otherwise the C++ object will not be cleaned up until the finalizer of this object is called.

Summary

Public Constructors
ServerControlSource()
Public Methods
abstract void SetNetworkClientReceiveTimeoutInMilliSeconds(int timeout)
Sets the network client receive timeout, in milliseconds, to use for the connect call.
abstract ServerMachine connect(String machineName)
This method will connect to the given remote machine's server control facilities.
abstract ServerMachine connectLocal()
This method will connect to the local machine's server control facilities.
static ServerControlSource getInstance()
Returns a new instance of the ServerControlSource class.
abstract SimpleList getLocalNetworkServers(int serverType)
Returns a list of local network servers which contain the specified type of MicroStrategy product on it.
abstract SimpleList getLocalNetworkServers()
Returns a list of local network servers which contain one or more MicroStrategy products on them.
abstract Locale getLocale()
Returns the current locale of the API.
abstract int getNetworkTimeout()
Returns the network timeout, in seconds, which will be used for the getLocalNetworkServers call.
abstract ServerMachine getServerMachine(String stateXML)
Returns a ServerMachine object populated from the given state XML.
abstract void purgeServerStatistics(WebIServerSession session, Date fromDate, Date toDate, int timeout, String projectName)
This method will attempt to purge the statistics of a certain period collected on server.
abstract void purgeServerStatistics(WebIServerSession session, Date fromDate, Date toDate, int timeout)
This method will attempt to purge the statistics of a certain period collected on server.
abstract void refreshDiagnosticsLoggingSettings(WebIServerSession session)
This method will attempt to refresh the diagnostics logging settings on the server which the WebIServerSession is created on.
abstract void refreshPerformanceLoggingSettings(WebIServerSession session)
This method will attempt to refresh the performance logging settings on the server which the WebIServerSession is created on.
abstract void release()
This method will release the underlying C++ API's memory structure.
abstract void setLocale(Locale locale)
Sets the locale of the error messages thrown by the API.
abstract void setNetworkTimeout(int timeoutInSecs)
Sets the network timeout, in seconds, to use for the getLocalNetworkServers call.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ServerControlSource ()

Public Methods

public abstract void SetNetworkClientReceiveTimeoutInMilliSeconds (int timeout)

Sets the network client receive timeout, in milliseconds, to use for the connect call.

Parameters
timeout The timeout to use for the connect call, in milliseconds.
Throws
ServerConfigException Thrown if an error occurs.
ServerControlException

public abstract ServerMachine connect (String machineName)

This method will connect to the given remote machine's server control facilities.

Parameters
machineName The name of the machine to connect to.
Returns
Throws
ServerConfigException Thrown if an error occurs.

public abstract ServerMachine connectLocal ()

This method will connect to the local machine's server control facilities.

Returns
Throws
ServerConfigException Thrown if an error occurs.

public static ServerControlSource getInstance ()

Returns a new instance of the ServerControlSource class.

Returns
  • A new instance of the ServerControlSource.

public abstract SimpleList getLocalNetworkServers (int serverType)

Returns a list of local network servers which contain the specified type of MicroStrategy product on it.

Parameters
serverType The type of server to search for, from EnumServerTypes.
Returns
  • A SimpleList object containing the names of the local network servers the API can find.
Throws
ServerConfigException Thrown if an error occurs when performing the operation.

public abstract SimpleList getLocalNetworkServers ()

Returns a list of local network servers which contain one or more MicroStrategy products on them.

Returns
  • A SimpleList object containing the names of the local network servers the API can find.
Throws
ServerConfigException Thrown if an error occurs when performing the operation.

public abstract Locale getLocale ()

Returns the current locale of the API.

Returns
  • A java.lang.Locale object describing the current locale of the API.

public abstract int getNetworkTimeout ()

Returns the network timeout, in seconds, which will be used for the getLocalNetworkServers call.

Returns
  • The current network timeout, in seconds, used for the getLocalNetworkServers call.
Throws
ServerConfigException Thrown if an error occurs.

public abstract ServerMachine getServerMachine (String stateXML)

Returns a ServerMachine object populated from the given state XML.

Parameters
stateXML The state XML for the object.
Returns
Throws
ServerConfigException Thrown if an error occurs.

public abstract void purgeServerStatistics (WebIServerSession session, Date fromDate, Date toDate, int timeout, String projectName)

This method will attempt to purge the statistics of a certain period collected on server.

Parameters
session WebIServerSession The session to user to purge the statistics.
fromDate Date The start date of the period to purge.
toDate Date The end date of the period to purge.
timeout int maximum time (in second) allowed for the purging process.
projectName String The Project Name whose statistics will be purged.
Throws
ServerConfigException Thrown if the purge failed.
WebObjectsException Thrown if there is a problem with the session passed in.

public abstract void purgeServerStatistics (WebIServerSession session, Date fromDate, Date toDate, int timeout)

This method will attempt to purge the statistics of a certain period collected on server.

Parameters
session WebIServerSession The session to user to purge the statistics.
fromDate Date The start date of the period to purge.
toDate Date The end date of the period to purge.
timeout int maximum time (in second) allowed for the purging process.
Throws
ServerConfigException Thrown if the purge failed.
WebObjectsException Thrown if there is a problem with the session passed in.

public abstract void refreshDiagnosticsLoggingSettings (WebIServerSession session)

This method will attempt to refresh the diagnostics logging settings on the server which the WebIServerSession is created on. This method will cause those settings to be re-read from the registry and applied to the server instance without restarting the server.

Parameters
session The session to use to refresh the performance logging settings.
Throws
ServerConfigException Thrown if the settings could not be refreshed.
WebObjectsException Thrown if there is a problem with the session passed in.

public abstract void refreshPerformanceLoggingSettings (WebIServerSession session)

This method will attempt to refresh the performance logging settings on the server which the WebIServerSession is created on. This method will cause those settings to be re-read from the registry and applied to the server instance without restarting the server.

Parameters
session The session to use to refresh the performance logging settings.
Throws
ServerConfigException Thrown if the settings could not be refreshed.
WebObjectsException Thrown if there is a problem with the session passed in.

public abstract void release ()

This method will release the underlying C++ API's memory structure. Calling this method is recommended when this object and all objects obtained from it are no longer being used. This method will clean up the C++ objects that this API communicates with. After calling this method, most methods on this interface or any objects obtained from this interface will fail. Also, note that it is not strictly necessary to call this method, as the C++ pointer will be cleaned up upon finalization as well.

public abstract void setLocale (Locale locale)

Sets the locale of the error messages thrown by the API.

Parameters
locale The java.lang.Locale of the user.
Throws
ServerConfigException Thrown if the locale cannot be set.

public abstract void setNetworkTimeout (int timeoutInSecs)

Sets the network timeout, in seconds, to use for the getLocalNetworkServers call.

Parameters
timeoutInSecs The timeout to use for the getLocalNetworkServers call, in seconds.
Throws
ServerConfigException Thrown if an error occurs.