Package com.microstrategy.web.objects.admin.serverconfig

Class RepositorySource

java.lang.Object

com.microstrategy.web.objects.admin.serverconfig.RepositorySource

public class RepositorySource
extends java.lang.Object

This class is intended to support Repository Initialization.

Since:

MicroStrategy Web 7.5.0

Constructor Summary

Constructors

Constructor	Description
RepositorySource()

Method Summary

Modifier and Type	Method	Description
static RepositorySource	getInstance()	Returns the singleton RepositorySource that should be used to initialize the Repository.
RepositorySettings	getRepositorySettings()	Returns the RepositorySettings object that should be filled up before attempting to initialize a repository.
void	initRepository(java.lang.String serverName, boolean useRepository)	Ensures that a repository exists at the data source referred by the RepositorySettings.
void	initRepository(java.lang.String serverName, int portNumber, boolean useRepository)	Ensures that a repository exists at the data source referred by the RepositorySettings.
void	initRepository(java.lang.String serverName, int portNumber, java.util.Locale locale, boolean useRepository)	Ensures that a repository exists at the data source referred by the RepositorySettings.
void	initRepository(java.lang.String serverName, java.util.Locale locale, boolean useRepository)	Ensures that a repository exists at the data source referred by the RepositorySettings.
boolean	isRepositoryInitialized(java.lang.String serverName)	Checks if repository exists at the data source referred by the RepositorySettings.
boolean	isRepositoryInitialized(java.lang.String serverName, int portNumber)	Checks if repository exists at the data source referred by the RepositorySettings.
boolean	isRepositoryInitialized(java.lang.String serverName, int portNumber, java.util.Locale locale)	Checks if repository exists at the data source referred by the RepositorySettings.
boolean	isRepositoryInitialized(java.lang.String serverName, java.util.Locale locale)	Checks if repository exists at the data source referred by the RepositorySettings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RepositorySource

public RepositorySource()

Method Detail

getInstance

public static RepositorySource getInstance()

Returns the singleton RepositorySource that should be used to initialize the Repository.

Returns:

RepositorySource the singleton RepositorySource object.

getRepositorySettings

public RepositorySettings getRepositorySettings()

Returns the RepositorySettings object that should be filled up before attempting to initialize a repository.

Returns:

RepositorySettings the repository settings object to be filled up.

isRepositoryInitialized

public boolean isRepositoryInitialized(java.lang.String serverName,
                                       int portNumber,
                                       java.util.Locale locale)
                                throws ServerConfigException,
                                       java.lang.IllegalArgumentException

Checks if repository exists at the data source referred by the RepositorySettings.

Parameters:

serverName - The IServer name

portNumber - The port number to communicate with IServer

locale - The locale for error messages

Returns:

boolean True if repository exists.

Throws:

ServerConfigException - If the Repository Settings are not properly filled up or if there was an error encountered by IServer.

java.lang.IllegalArgumentException

isRepositoryInitialized

public boolean isRepositoryInitialized(java.lang.String serverName,
                                       int portNumber)
                                throws ServerConfigException

Checks if repository exists at the data source referred by the RepositorySettings.

Parameters:

serverName - The IServer name

portNumber - The port number to communicate with IServer

Returns:

boolean True if repository exists.

Throws:

ServerConfigException - If the Repository Settings are not properly filled up or if there was an error encountered by IServer.

isRepositoryInitialized

public boolean isRepositoryInitialized(java.lang.String serverName,
                                       java.util.Locale locale)
                                throws ServerConfigException

Checks if repository exists at the data source referred by the RepositorySettings.

Parameters:

serverName - The IServer name. Default Port Number is used.

locale - The locale for error messages

Returns:

boolean True if repository exists.

Throws:

ServerConfigException - If the Repository Settings are not properly filled up or if there was an error encountered by IServer.

isRepositoryInitialized

public boolean isRepositoryInitialized(java.lang.String serverName)
                                throws ServerConfigException

Checks if repository exists at the data source referred by the RepositorySettings.

Parameters:

serverName - The IServer name. Default Port Number is used.

Returns:

boolean True if repository exists.

Throws:

ServerConfigException - If the Repository Settings are not properly filled up or if there was an error encountered by IServer.

initRepository

public void initRepository(java.lang.String serverName,
                           int portNumber,
                           java.util.Locale locale,
                           boolean useRepository)
                    throws ServerConfigException

Ensures that a repository exists at the data source referred by the RepositorySettings. Also, if the useRepository flag is set to True, ensures that IServer starts using the repository.

Parameters:

serverName - The IServer name

portNumber - The port number to communicate with IServer

locale - The locale for error messages

useRepository - If set to True, IServer would start using the repository. A value of False for this means that we would not attempt to ensure that IServer uses this repository. Thus, setting the value to False would not affect the current repository used by IServer (if any).

Throws:

ServerConfigException - If the Repository Settings are not properly filled up or if there was an error encountered by IServer.

initRepository

public void initRepository(java.lang.String serverName,
                           int portNumber,
                           boolean useRepository)
                    throws ServerConfigException

Ensures that a repository exists at the data source referred by the RepositorySettings. Also, if the useRepository flag is set to True, ensures that IServer starts using the repository.

Parameters:

serverName - The IServer name

portNumber - The port number to communicate with IServer

useRepository - If set to True, IServer would start using the repository. A value of False for this means that we would not attempt to ensure that IServer uses this repository. Thus, setting the value to False would not affect the current repository used by IServer (if any).

Throws:

ServerConfigException - If the Repository Settings are not properly filled up or if there was an error encountered by IServer.

initRepository

public void initRepository(java.lang.String serverName,
                           java.util.Locale locale,
                           boolean useRepository)
                    throws ServerConfigException

Ensures that a repository exists at the data source referred by the RepositorySettings. Also, if the useRepository flag is set to True, ensures that IServer starts using the repository.

Parameters:

serverName - The IServer name. The Default Port Number will be used to communicate with the IServer.

locale - The locale for error messages

useRepository - If set to True, IServer would start using the repository. A value of False for this means that we would not attempt to ensure that IServer uses this repository. Thus, setting the value to False would not affect, at all, the current repository used by IServer (if any).

Throws:

ServerConfigException - If the Repository Settings are not properly filled up or if there was an error encountered by IServer.

initRepository

public void initRepository(java.lang.String serverName,
                           boolean useRepository)
                    throws ServerConfigException

Ensures that a repository exists at the data source referred by the RepositorySettings. Also, if the useRepository flag is set to True, ensures that IServer starts using the repository.

Parameters:

serverName - The IServer name. The Default Port Number will be used to communicate with the IServer.

useRepository - If set to True, IServer would start using the repository. A value of False for this means that we would not attempt to ensure that IServer uses this repository. Thus, setting the value to False would not affect the current repository used by IServer (if any).

Throws:

ServerConfigException - If the Repository Settings are not properly filled up or if there was an error encountered by IServer.