public interface

DataSource

com.microstrategy.web.objects.admin.DataSource

Class Overview

The DataSource interface represents a single Data Source, which represents the settings for a 2- or 3-tier connection. DataSource objects can be obtained and created from the DataSourceEnumerator interface. The name and connection type of a DataSource object is set upon creation, and cannot be changed. Note that any changes made to the DataSource object will not take place until either the save method on the DataSourceEnumerator interface or the save method on this interface is called.

Summary

Public Methods
abstract void changePassword(String newPassword)
This method changes the password to the newly set password on the Intelligence Server which this data source points to.
abstract void clearKeyValues()
Clears all key values from the key values collection.
abstract WebIServerSession createSession()
Creates a 4-tier session using the parameters set on this interface.
abstract int getApplicationType()
Returns the application type set on the DataSource, from EnumDSSXMLApplicationType.}
abstract int getAuthMode()
Returns the current setting of the AuthMode parameter.
abstract int getAvailableAuthModes()
Returns the list of available auth modes, based on the type of the DataSource.
abstract String getCacheSetting(int settingType)
This method will return the current setting for the given cache setting type.
abstract String getClientID()
Returns the identifier that will be sent to the IntelligenceServer upon calling createSession, which identifies the IP address of the XMLAPI machine.
abstract String getConfigurationID()
Returns the current value of the configuration ID property of the DataSource.
abstract String getConfigurationName()
Returns the configuration name property of the DataSource.
abstract int getConnectionType()
Returns the connection type of the data source.
abstract int getDBType()
Returns the DB type property set on the DataSource.
abstract int getFlags()
Returns the flags property of the DataSource.
abstract int getInternalProjectID()
Returns the internal project ID set on the DataSource.
abstract String getKeyValue(String key)
Returns the key value with the given name in the key value collection.
abstract String[] getKeyValueNames()
Returns the names of all currently existing key values.
abstract Locale getLocale()
Returns the locale property of the DataSource
abstract String getLocation()
Returns the location property on the DataSource.
abstract String getLogin()
Returns the login parameter of the DataSource.
abstract String getMDLogin()
Returns the MD login parameter of the DataSource.
abstract int getMDVersion()
Returns the metadata version set on the DataSource.
abstract String getName()
Returns the name of the data source.
abstract int getPort()
Returns the port property of the DataSource.
abstract String getProjectID()
Returns the project ID set on the DataSource.
abstract String getProjectName()
Returns the project name set on the DataSource.
abstract String getServerInstanceID()
Returns the current setting of the server instance ID of the DataSource.
abstract String getServerInstanceName()
Returns the current setting of the server instance name property of the DataSource.
abstract int getServerVersion()
Returns the server version property.
abstract int getSessionFlags()
Returns the current session flags property on the DataSource.
abstract int getTimeout()
Returns the timeout property of the DataSource.
abstract String getWHLogin()
Returns the current value of the WH login property of the DataSource.
abstract boolean isHidden()
Returns whether the DataSource is hidden.
abstract void removeKeyValue(String key)
Removes the given key value from the list of key values.
abstract void save()
Saves any changes to this data source object back to the registry.
abstract void setApplicationType(int type)
Sets the application type of the DataSource.
abstract void setAuthMode(int mode)
Sets the AuthMode parameter of the DataSource.
abstract void setCacheSetting(int settingType, String settingValue)
Sets the given cache setting to the given value.
abstract void setClientID(String clientID)
Sets the identifier that will be sent to the IntelligenceServer upon calling createSession, which identifies the IP address of the XMLAPI machine.
abstract void setConfigurationID(String id)
Sets the configuration ID property of the DataSource.
abstract void setConfigurationName(String name)
Sets the configuration name property of the DataSource.
abstract void setDBType(int type)
Sets the DB type property.
abstract void setFlags(int flags)
Sets the flags on the DataSource.
abstract void setHidden(boolean hidden)
Sets the hidden flag of the DataSource.
abstract void setInternalProjectID(int id)
Sets the internal project ID on the DataSource.
abstract void setKeyValue(String key, String val)
Sets a key value with the given name.
abstract void setLocale(Locale locale)
Sets the locale property of the DataSource.
abstract void setLocation(String location)
Sets the location property on the DataSource.
abstract void setLogin(String login)
Sets the login parameter of the DataSource.
abstract void setMDLogin(String login)
Sets the MD login parameter of the DataSource.
abstract void setMDPasswd(String password)
Sets the MD password parameter of the DataSource.
abstract void setMDVersion(int version)
Sets the metadata version on the DataSource.
abstract void setPasswd(String password)
Sets the password on the DataSource.
abstract void setPort(int port)
Sets the port property of the DataSource.
abstract void setProjectID(String id)
Sets the project ID on the DataSource.
abstract void setProjectName(String name)
Sets the project name on the DataSource.
abstract void setServerInstanceID(String id)
Sets the server instance ID on the DataSource.
abstract void setServerInstanceName(String name)
Sets the server instance name of the DataSource.
abstract void setServerVersion(int version)
Sets the server version on the data source.
abstract void setSessionFlags(int flags)
Sets the session flags on the DataSource.
abstract void setTimeout(int timeout)
Sets the timeout property of the DataSource.
abstract void setUseSSL(boolean _useSSL)
Sets useSSL flag which identifies whether to use secure connection.
abstract void setWHLogin(String login)
Sets the WH login property of the DataSource.
abstract void setWHPasswd(String password)
Sets the WH password property of the DataSource.
abstract boolean useSSL()
Returns useSSL flag.

Public Methods

public abstract void changePassword (String newPassword)

This method changes the password to the newly set password on the Intelligence Server which this data source points to. It creates a 4-tier connection to do this. This will also change the password variable on this DataSource to the new password. This method will only work on a DataSource with connection type EnumDSSXMLDataSourceConnectionType.DssXmlConnectionType3Tier.

Parameters
newPassword The new password to use.
Throws
WebObjectsException Thrown if an error occurs.

public abstract void clearKeyValues ()

Clears all key values from the key values collection.

public abstract WebIServerSession createSession ()

Creates a 4-tier session using the parameters set on this interface. This method will only work on a DataSource with connection type EnumDSSXMLDataSourceConnectionType.DssXmlConnectionType3Tier.

Returns
  • The WebIServerSession populated with the parameters set on this interface.
Throws
WebObjectsException Thrown if an error occurs.

public abstract int getApplicationType ()

Returns the application type set on the DataSource, from EnumDSSXMLApplicationType.}

Returns

public abstract int getAuthMode ()

Returns the current setting of the AuthMode parameter.

Returns

public abstract int getAvailableAuthModes ()

Returns the list of available auth modes, based on the type of the DataSource.

Returns

public abstract String getCacheSetting (int settingType)

This method will return the current setting for the given cache setting type.

Parameters
settingType The type of the setting to return, from EnumDSSXMLCacheSetting.
Returns
  • The current value of the given cache setting.

public abstract String getClientID ()

Returns the identifier that will be sent to the IntelligenceServer upon calling createSession, which identifies the IP address of the XMLAPI machine.

Returns
  • The current setting for the client ID.

public abstract String getConfigurationID ()

Returns the current value of the configuration ID property of the DataSource.

Returns
  • The value of the configuration ID property.

public abstract String getConfigurationName ()

Returns the configuration name property of the DataSource.

Returns
  • The current setting of the configuration name.

public abstract int getConnectionType ()

Returns the connection type of the data source. The value of this method will come from EnumDSSXMLDataSourceConnectionType.

Returns

public abstract int getDBType ()

Returns the DB type property set on the DataSource.

Returns

public abstract int getFlags ()

Returns the flags property of the DataSource.

Returns

public abstract int getInternalProjectID ()

Returns the internal project ID set on the DataSource.

Returns
  • The internal project ID property of the DataSource.

public abstract String getKeyValue (String key)

Returns the key value with the given name in the key value collection.

Parameters
key The name of the key value to return.
Returns
  • The value corresponding to the given key name.

public abstract String[] getKeyValueNames ()

Returns the names of all currently existing key values.

Returns
  • An array of Strings containing the names of the existing key values.

public abstract Locale getLocale ()

Returns the locale property of the DataSource

Returns
  • A java.util.Locale which represents the Locale set on the DataSource.

public abstract String getLocation ()

Returns the location property on the DataSource.

Returns
  • The current value for location.

public abstract String getLogin ()

Returns the login parameter of the DataSource.

Returns
  • The current setting of the login parameter of the DataSource.

public abstract String getMDLogin ()

Returns the MD login parameter of the DataSource.

Returns
  • The MD login on the DataSource.

public abstract int getMDVersion ()

Returns the metadata version set on the DataSource.

Returns

public abstract String getName ()

Returns the name of the data source.

Returns
  • The name of the data source object.

public abstract int getPort ()

Returns the port property of the DataSource.

Returns
  • The port property of the DataSource.

public abstract String getProjectID ()

Returns the project ID set on the DataSource.

Returns
  • The current value of the project ID property on the DataSource.

public abstract String getProjectName ()

Returns the project name set on the DataSource.

Returns
  • The project name set on the DataSource.

public abstract String getServerInstanceID ()

Returns the current setting of the server instance ID of the DataSource.

Returns
  • The server instance ID set on the DataSource.

public abstract String getServerInstanceName ()

Returns the current setting of the server instance name property of the DataSource.

Returns
  • The current server instance name of the DataSource.

public abstract int getServerVersion ()

Returns the server version property.

Returns
  • The current value of the server version property.

public abstract int getSessionFlags ()

Returns the current session flags property on the DataSource.

Returns

public abstract int getTimeout ()

Returns the timeout property of the DataSource.

Returns
  • The current timeout property of the DataSource.

public abstract String getWHLogin ()

Returns the current value of the WH login property of the DataSource.

Returns
  • The current setting for WH login.

public abstract boolean isHidden ()

Returns whether the DataSource is hidden.

Returns
  • True if the DataSource is hidden, false otherwise.

public abstract void removeKeyValue (String key)

Removes the given key value from the list of key values.

Parameters
key The name of the key to remove.

public abstract void save ()

Saves any changes to this data source object back to the registry. Note that if the object has been removed from the owner DataSourceEnumerator, then this call will fail.

Throws
WebObjectsAdminException Thrown if an error occurs when saving.
UnsupportedOperationException Thrown if the data source has been removed from the parent enumerator.

public abstract void setApplicationType (int type)

Sets the application type of the DataSource.

Parameters
type The new application type, from EnumDSSXMLApplicationType.

public abstract void setAuthMode (int mode)

Sets the AuthMode parameter of the DataSource.

Parameters
mode The new value of the AuthMode parameter, from EnumDSSXMLAuthModes.}

public abstract void setCacheSetting (int settingType, String settingValue)

Sets the given cache setting to the given value.

Parameters
settingType The type of the cache setting, from EnumDSSXMLCacheSetting.
settingValue The new value for the cache setting.

public abstract void setClientID (String clientID)

Sets the identifier that will be sent to the IntelligenceServer upon calling createSession, which identifies the IP address of the XMLAPI machine.

Parameters
clientID The setting to be used for client ID upon creating a session.

public abstract void setConfigurationID (String id)

Sets the configuration ID property of the DataSource.

Parameters
id The new value of the configuration ID property of the DataSource.

public abstract void setConfigurationName (String name)

Sets the configuration name property of the DataSource.

Parameters
name The new value of the configuration name property of the data source.

public abstract void setDBType (int type)

Sets the DB type property.

Parameters
type The new setting for the DB type property - a value from EnumDSSXMLDatabaseType.

public abstract void setFlags (int flags)

Sets the flags on the DataSource.

Parameters
flags The new setting for the flags property. This should be the bitwise OR(|) of values from EnumDSSXMLDataSourceFlags.

public abstract void setHidden (boolean hidden)

Sets the hidden flag of the DataSource.

Parameters
hidden The new value of the hidden flag.

public abstract void setInternalProjectID (int id)

Sets the internal project ID on the DataSource.

Parameters
id The new value for the internal project ID property.

public abstract void setKeyValue (String key, String val)

Sets a key value with the given name. If one already exists with the given name, then the old value will be overwritten.

Parameters
key The name of the key whose value will be changed.
val The new value for the key.

public abstract void setLocale (Locale locale)

Sets the locale property of the DataSource.

Parameters
locale A java.util.Locale representing the Locale to be set on the DataSource.

public abstract void setLocation (String location)

Sets the location property on the DataSource.

Parameters
location The location to set on the DataSource.

public abstract void setLogin (String login)

Sets the login parameter of the DataSource.

Parameters
login A new value of the login parameter of the DataSource.

public abstract void setMDLogin (String login)

Sets the MD login parameter of the DataSource.

Parameters
login The new value of the MD login parameter of the DataSource.

public abstract void setMDPasswd (String password)

Sets the MD password parameter of the DataSource.

Parameters
password The new value of the MD password parameter of the DataSource.

public abstract void setMDVersion (int version)

Sets the metadata version on the DataSource.

Parameters
version The metadata version to set on the DataSource, from EnumDSSXMLMDVersion.

public abstract void setPasswd (String password)

Sets the password on the DataSource.

Parameters
password The password to set on the DataSource.

public abstract void setPort (int port)

Sets the port property of the DataSource.

Parameters
port The new value of the port property of the DataSource.

public abstract void setProjectID (String id)

Sets the project ID on the DataSource.

Parameters
id The ID ot set on the DataSource.

public abstract void setProjectName (String name)

Sets the project name on the DataSource.

Parameters
name The new project name to set on the property on the DataSource.

public abstract void setServerInstanceID (String id)

Sets the server instance ID on the DataSource.

Parameters
id The new value for the server instance ID.

public abstract void setServerInstanceName (String name)

Sets the server instance name of the DataSource.

Parameters
name The new server instance name to set on the DataSource.

public abstract void setServerVersion (int version)

Sets the server version on the data source.

Parameters
version The server version to set on the data source.

public abstract void setSessionFlags (int flags)

Sets the session flags on the DataSource.

Parameters
flags The bitwise or of values from EnumDSSXMLSessionFlags.

public abstract void setTimeout (int timeout)

Sets the timeout property of the DataSource.

Parameters
timeout The timeout to set on the DataSource.

public abstract void setUseSSL (boolean _useSSL)

Sets useSSL flag which identifies whether to use secure connection.

Parameters
_useSSL true or false.

public abstract void setWHLogin (String login)

Sets the WH login property of the DataSource.

Parameters
login The new value of the WH login property.

public abstract void setWHPasswd (String password)

Sets the WH password property of the DataSource.

Parameters
password The new value of the WH password property.

public abstract boolean useSSL ()

Returns useSSL flag.

Returns
  • true or false.