Package com.microstrategy.web.objects
Interface WebServerDef
-
- All Superinterfaces:
KeyedObject
,WebDisplayUnit
,WebFeatures
,WebObjectInfo
,WebPromptSite
public interface WebServerDef extends WebObjectInfo
This interface represents a Server Definition object, which is a type of first-class object. The first class objects of typeEnumDSSXMLObjectTypes
.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 onWebObjectSource
must be called.- Since:
- MicroStrategy Web 7.5.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
getApplyOnSave()
This method will return the current setting of the apply on save flag.WebChannels
getChannels()
Returns a list of channels which exist on the server.WebFences
getFences()
WebLDAPSettings
getLDAPSettings()
Returns a collection of LDAP-related settings, which can be used to modify the LDAP settings of the server definition object.WebProjectReferences
getProjectReferences()
Returns the project references which are registered with this Server Definition object.WebServerSettings
getServerSettings()
Returns the collection of server settings on the server definition.WebSimpleSecurityPluginSettings
getSimpleSecurityPluginSettings()
WebWarehousePassthroughSettings
getWarehousePassthroughSettings()
void
setApplyOnSave(boolean applyOnSave)
This method will set the apply on save flag to the given value.-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected
-
Methods inherited from interface com.microstrategy.web.objects.WebFeatures
isFeatureAvailable, isFeatureAvailable
-
Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo
buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags
-
Methods inherited from interface com.microstrategy.web.objects.WebPromptSite
getPromptInstances
-
-
-
-
Method Detail
-
getProjectReferences
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.
-
getChannels
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. - Since:
- MicroStrategy Web 7.5.2
-
getServerSettings
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.
- Since:
- MicroStrategy Web 7.5.2
-
getLDAPSettings
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. - Since:
- MicroStrategy Web 7.5.2
-
getApplyOnSave
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 theWebObjectSource
.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.
- Since:
- MicroStrategy Web 7.5.2
-
setApplyOnSave
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.- Since:
- MicroStrategy Web 7.5.2
-
getSimpleSecurityPluginSettings
WebSimpleSecurityPluginSettings getSimpleSecurityPluginSettings()
- Since:
- MicroStrategy Web 9.0.0
-
getWarehousePassthroughSettings
WebWarehousePassthroughSettings getWarehousePassthroughSettings()
-
getFences
WebFences getFences() throws WebObjectsException
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 10.4
-
-