public interface

WebServerDef

implements WebObjectInfo
com.microstrategy.web.objects.WebServerDef

Class Overview

This interface represents a Server Definition object, which is a type of first-class object. The first class objects of type EnumDSSXMLObjectTypes.DssXmlTypeServerDef will implement this interface when viewed through the Web Objects. This interface contains methods to examine and change the settings of the ServerDef object. In order to save any changes made to this interface, the save or copy methods on WebObjectSource must be called.

Summary

Public Methods
abstract boolean getApplyOnSave()
This method will return the current setting of the apply on save flag.
abstract WebChannels getChannels()
Returns a list of channels which exist on the server.
abstract WebFences getFences()
abstract WebLDAPSettings getLDAPSettings()
Returns a collection of LDAP-related settings, which can be used to modify the LDAP settings of the server definition object.
abstract WebProjectReferences getProjectReferences()
Returns the project references which are registered with this Server Definition object.
abstract WebServerSettings getServerSettings()
Returns the collection of server settings on the server definition.
abstract WebSimpleSecurityPluginSettings getSimpleSecurityPluginSettings()
abstract void setApplyOnSave(boolean applyOnSave)
This method will set the apply on save flag to the given value.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract boolean getApplyOnSave ()

This method will return the current setting of the apply on save flag. This flag will tell whether, for a ServerDef being used by the Intelligence Server, a direction will be sent to the Intelligence Server to refresh the runtime settings from the ServerDef will be sent when saving the ServerDef. If a ServerDef is obtained from the WebObjectSource.getActiveServerDef call, this will be true by default, otherwise it will be false by default. Note that if this is set on a ServerDef which is not being used by the Intelligence Server, nothing will happen.

Returns
  • The current value of the apply on save flag.

public abstract WebChannels getChannels ()

Returns a list of channels which exist on the server. This collection of channels can be used to examine or modify the channel settings on the server.

Returns
  • A WebChannels collection which contains all channels on the server definition.

public abstract WebFences getFences ()

public abstract WebLDAPSettings getLDAPSettings ()

Returns a collection of LDAP-related settings, which can be used to modify the LDAP settings of the server definition object.

Returns
  • A WebLDAPSettings collection, containing all LDAP settings for the server definition.

public abstract WebProjectReferences getProjectReferences ()

Returns the project references which are registered with this Server Definition object. The return interface from this method can also be used to add, remove, and modify the project references registered with the Server Definition object.

Returns
  • A WebProjectReferences collection containing the project references registered with the server definition object.

public abstract WebServerSettings getServerSettings ()

Returns the collection of server settings on the server definition. This collection can be used to examine and modify the settings of the server definition object.

Returns
  • A collection which contains all settings on the server definition.

public abstract WebSimpleSecurityPluginSettings getSimpleSecurityPluginSettings ()

public abstract void setApplyOnSave (boolean applyOnSave)

This method will set the apply on save flag to the given value. This flag will tell whether, for a ServerDef being used by the Intelligence Server, a direction will be sent to the Intelligence Server to refresh the runtime settings from the ServerDef will be sent when saving the ServerDef. Note that if this is set on a ServerDef which is not being used by the Intelligence Server, nothing will happen.

Parameters
applyOnSave The new setting for the flag.