public interface

IntelligenceServerInstance

implements ServerInstance
com.microstrategy.web.objects.admin.serverconfig.IntelligenceServerInstance

Class Overview

This interface represents a server instance object which is for an Intelligence Server. This interface extends the ServerInstance interface, and contains Intelligence Server-specific methods. Note that any changes made to the properties on this interface will not take place until the save method is called on the parent ServerInstance interface.

Summary

Constants
int UNSET_CHARACTER_ENCODING
Public Methods
abstract String getCACertificatePath()
Returns the SSL CA Certificate
abstract String getCertificatePath()
Returns the SSL Certificate Path
abstract DiagnosticsConfiguration getDiagnosticsConfiguration()
Returns the DiagnosticsConfiguration for this server instance.
abstract String getKeyPath()
Returns the SSL Key Path
abstract String getMDDataSourceName()
Returns the current metadata data source name(DSN) of the instance.
abstract String getMDLogin()
Returns the metadata login set on the instance.
abstract String getMDODBCSettings()
Returns the current values of additional ODBC settings (other than the DSN) which are used for the metadata connection for the current instance.
abstract String getMDTablePrefix()
Returns the metadata table prefix to use for the server instance.
abstract String getMDTempTablePrefix()
Returns the current setting for the metadata temp table prefix of the server instance.
abstract int getODBCCharacterEncoding()
Returns the character encoding used by the ODBC driver for this server instance
abstract PerformanceLoggingConfiguration getPerformanceLoggingConfiguration()
Returns the PerformanceLoggingConfiguration for this server instance.
abstract int getProcessorAffinityMask()
This method is deprecated. use getSerializedAffinity() instead. This method no longer works
abstract int getSSLCCPort()
Returns the SSL Port
abstract int getSSLPort()
Returns the SSL Port
abstract String getSerializedAffinity()
Returns the current setting of the processor affinity mask of the server instance.
abstract String getServerDefName()
Returns the name of the server definition object associated with the instance.
abstract int getTCPPortNumber()
Returns the port number set on the server instance.
abstract int getVerifyCertificate()
Returns the SSL Verify Certificate
abstract boolean isPerformanceMonitoringEnabled()
Returns whether performance monitoring is enabled on an Intelligence Server which uses the instance.
abstract boolean isProcessorAffinitySupported()
Returns whether the Intelligence Server supports processor affinity.
abstract void setCACertificatePath(String CACertificatePath)
Sets the SSL CA Certificate
abstract void setCertificateKeyPassword(String certKeyPwd)
Sets the SSL Certificate Key Password
abstract void setCertificatePath(String certPath)
Sets the SSL Certificate Path
abstract void setKeyPath(String keyPath)
Sets the SSL Key Path
abstract void setMDDataSourceName(String mdDSN)
Sets the data source name(DSN) of the metadata for the instance.
abstract void setMDLogin(String mdLogin, String mdPassword)
This method will set the login and password for the metadata to use for this server instance.
abstract void setMDODBCSettings(String mdODBCSettings)
Sets an additional set of ODBC settings (other than the DSN) which will be used when this instance is connecting to the metadata.
abstract void setMDTablePrefix(String mdTablePrefix)
Sets the metadata table prefix of the server instance.
abstract void setMDTempTablePrefix(String mdTempTablePrefix)
Sets the metadata temp table prefix on the server instance.
abstract void setODBCCharacterEncoding(int encoding)
Set the type of character encoding used by the ODBC driver for this server instance
abstract void setPerformanceMonitoringEnabled(boolean isEnabled)
Sets whether performance monitoring is enabled on an Intelligence Server which uses the instance.
abstract void setProcessorAffinityMask(int mask)
This method is deprecated. use setProcessorAffinityMask(String) instead. This menthod no longer works
abstract void setProcessorAffinityMask(String mask)
Sets the processor affinity mask of the server instance.
abstract void setSSLCCPort(int SSLCCPort)
Sets the SSL Port
abstract void setSSLPort(int SSLPort)
Sets the SSL Port
abstract void setServerDefName(String name)
Sets the Server Definition object to associate with the server instance.
abstract void setTCPPortNumber(int tcpPortNumber)
Sets the port number of the server instance.
abstract void setVerifyCertificate(int verifyCert)
Sets the SSL Verify Certificate
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.admin.serverconfig.ServerInstance

Constants

public static final int UNSET_CHARACTER_ENCODING

Constant Value: -1 (0xffffffff)

Public Methods

public abstract String getCACertificatePath ()

Returns the SSL CA Certificate

public abstract String getCertificatePath ()

Returns the SSL Certificate Path

public abstract DiagnosticsConfiguration getDiagnosticsConfiguration ()

Returns the DiagnosticsConfiguration for this server instance.

Returns
  • DiagnosticsConfiguration the diagnostics configuration for this server instance.
Throws
ServerConfigException If an error was encountered while populating the diagnostics configuration.

public abstract String getKeyPath ()

Returns the SSL Key Path

public abstract String getMDDataSourceName ()

Returns the current metadata data source name(DSN) of the instance.

Returns
  • The data source name for the metadata.

public abstract String getMDLogin ()

Returns the metadata login set on the instance.

Returns
  • The metadata login set on the instance.

public abstract String getMDODBCSettings ()

Returns the current values of additional ODBC settings (other than the DSN) which are used for the metadata connection for the current instance.

Returns
  • The current additional ODBC settings string.

public abstract String getMDTablePrefix ()

Returns the metadata table prefix to use for the server instance.

Returns
  • The current metadata table prefix for the server instance.

public abstract String getMDTempTablePrefix ()

Returns the current setting for the metadata temp table prefix of the server instance.

Returns
  • The metadata temp table prefix of the server instance.

public abstract int getODBCCharacterEncoding ()

Returns the character encoding used by the ODBC driver for this server instance

Returns

public abstract PerformanceLoggingConfiguration getPerformanceLoggingConfiguration ()

Returns the PerformanceLoggingConfiguration for this server instance.

Returns
  • PerformanceLoggingConfiguration the performance logging configuration for this server instance.
Throws
ServerConfigException If an error was encountered while populating the logging configuration.

public abstract int getProcessorAffinityMask ()

This method is deprecated.
use getSerializedAffinity() instead. This method no longer works

Returns the current setting of the processor affinity mask of the server instance.

Returns
  • The current processor affinity mask of the instance.

public abstract int getSSLCCPort ()

Returns the SSL Port

public abstract int getSSLPort ()

Returns the SSL Port

public abstract String getSerializedAffinity ()

Returns the current setting of the processor affinity mask of the server instance.

Returns
  • The current processor affinity mask of the instance.

public abstract String getServerDefName ()

Returns the name of the server definition object associated with the instance.

Returns
  • The name of the server definition object associated with the instance.

public abstract int getTCPPortNumber ()

Returns the port number set on the server instance.

Returns
  • The current port number that the server instance will use.

public abstract int getVerifyCertificate ()

Returns the SSL Verify Certificate

public abstract boolean isPerformanceMonitoringEnabled ()

Returns whether performance monitoring is enabled on an Intelligence Server which uses the instance. If this is turned off, then all performance monitoring on the Intelligence Server will be disabled - both logging and live monitoring.

Returns
  • Whether performance monitoring is enabled on the server.

public abstract boolean isProcessorAffinitySupported ()

Returns whether the Intelligence Server supports processor affinity.

Returns
  • True if the server supports processor affinity, false otherwise.

public abstract void setCACertificatePath (String CACertificatePath)

Sets the SSL CA Certificate

public abstract void setCertificateKeyPassword (String certKeyPwd)

Sets the SSL Certificate Key Password

public abstract void setCertificatePath (String certPath)

Sets the SSL Certificate Path

public abstract void setKeyPath (String keyPath)

Sets the SSL Key Path

public abstract void setMDDataSourceName (String mdDSN)

Sets the data source name(DSN) of the metadata for the instance.

Parameters
mdDSN The data source name of the metadata which should be set on the instance.

public abstract void setMDLogin (String mdLogin, String mdPassword)

This method will set the login and password for the metadata to use for this server instance.

Parameters
mdLogin The metadata login.
mdPassword The metadata password.

public abstract void setMDODBCSettings (String mdODBCSettings)

Sets an additional set of ODBC settings (other than the DSN) which will be used when this instance is connecting to the metadata.

Parameters
mdODBCSettings The new ODBC settings string to use.

public abstract void setMDTablePrefix (String mdTablePrefix)

Sets the metadata table prefix of the server instance.

Parameters
mdTablePrefix The metadata table prefix to use for the server instance.

public abstract void setMDTempTablePrefix (String mdTempTablePrefix)

Sets the metadata temp table prefix on the server instance.

Parameters
mdTempTablePrefix The temp table prefix to use for the server instance.

public abstract void setODBCCharacterEncoding (int encoding)

Set the type of character encoding used by the ODBC driver for this server instance

Parameters
encoding int from EnumDSSXMLCharacterEncoding

public abstract void setPerformanceMonitoringEnabled (boolean isEnabled)

Sets whether performance monitoring is enabled on an Intelligence Server which uses the instance. If this is turned off, then all performance monitoring on the Intelligence Server will be disabled - both logging and live monitoring.

Parameters
isEnabled The new setting for performance monitoring on the Intelligence Server.

public abstract void setProcessorAffinityMask (int mask)

This method is deprecated.
use setProcessorAffinityMask(String) instead. This menthod no longer works

Sets the processor affinity mask of the server instance.

Parameters
mask The processor affinity mask to set on the instance.

public abstract void setProcessorAffinityMask (String mask)

Sets the processor affinity mask of the server instance.

Parameters
mask The processor affinity mask to set on the instance.

public abstract void setSSLCCPort (int SSLCCPort)

Sets the SSL Port

public abstract void setSSLPort (int SSLPort)

Sets the SSL Port

public abstract void setServerDefName (String name)

Sets the Server Definition object to associate with the server instance.

Parameters
name The name of the server definition object to set in the server instance.

public abstract void setTCPPortNumber (int tcpPortNumber)

Sets the port number of the server instance.

Parameters
tcpPortNumber The port number the server instance should use when starting.

public abstract void setVerifyCertificate (int verifyCert)

Sets the SSL Verify Certificate