de.innovationgate.wga.server.api

Class Server

java.lang.Object

de.innovationgate.wga.server.api.Server

public class Server
extends Object

This provides information and services regarding the OpenWGA server runtime and installation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Server.ServerOccasion A problem occasion created by startProblemOccasion(Class, Object, String, boolean)

Method Summary

Modifier and Type	Method and Description
List<String>	clearAllCaches() Clears all clearable caches on this OpenWGA runtime including: Data, user and file publishing caches on all web applications and data sources WebTML cache TMLScript code cache Design file cache This should be run in a master session.
Collection<String>	getAppKeys() Returns a List of database keys of all OpenWGA applications, excluding data sources
String	getBaseURL() Returns the base URL to reach this OpenWGA runtime This is the base part of every OpenWGA URL that is necessary to address the OpenWGA server itself, without any extra path information that is used to address resources within OpenWGA.
File	getConfigFolder() Returns the folder in which is used for WGA configuration Every OpenWGA installation uses a special folder for file data that is managed by the server itself.
Collection<String>	getDatabaseKeys() Returns a List of database keys of all OpenWGA databases, including apps and data sources
Collection<String>	getDataSourceKeys() Returns a List of database keys of all OpenWGA data sources, excluding full applications
Collection<String>	getDomainNames() Returns the names of all OpenWGA domains
de.innovationgate.utils.DynamicClassLoadingChain	getLibraryLoader() Returns the library class loader used by OpenWGA to load extension classes
org.apache.log4j.Logger	getLog() Returns the application log logger of the server
de.innovationgate.wga.modules.ModuleRegistry	getModuleRegistry() Returns the OpenWGA module registry
ProblemRegistry	getProblemRegistry() Returns OpenWGAs problem registry
Object	getServerOption(String name) Reads a server option This method returns the server option value in its native data type, like determined in module registry.
ServletContext	getServletContext() Returns the JavaEE servlet context of OpenWGA This object of type javax.servlet.ServletContext is the basic context object of OpenWGA as Java Web Application.
de.innovationgate.wga.common.beans.csconfig.v1.Version	getVersion() Returns the WGA server version
void	performPluginOperations(List<WorkspaceOperation> ops) Performs plugin operations on the current WGA plugin set
List<String>	reconnect(List<String> uidsToReconnect) Reconnects database belonging to the given config UIDs
void	reloadConfig() Reloads the server configuration
List<String>	reloadConfig(List<String> uidsToReconnect) Reloads the server configuration, reconnecting the databases belonging to the given config UIDs
File	resolveSystemFile(String fileName) Tries to find an "OpenWGA system file" of the given file name or path in the servers file system This method can be used to lookup files related to OpenWGA, no matter if they are specified as complete path or as relative path/name to OpenWGAs config folder.
Server.ServerOccasion	startProblemOccasion(Class<?> refClass, Object scopeObject, String baseKey) Starts a generic problem occasion for OpenWGA non-design-related problems.
Server.ServerOccasion	startProblemOccasion(Class<?> refClass, Object scopeObject, String baseKey, boolean clear) Starts a generic problem occasion for OpenWGA non-design-related problems
Server.ServerOccasion	startProblemOccasion(Class<?> refClass, String baseKey) Starts a generic problem occasion for OpenWGA non-design-related problems.
Server.ServerOccasion	startProblemOccasion(Class<?> refClass, String baseKey, boolean clear) Starts a generic problem occasion for OpenWGA non-design-related problems.
void	updateConfig(de.innovationgate.wga.config.WGAConfiguration cfg) Updates the server configuration with the given configuration.
void	updateConfig(de.innovationgate.wga.config.WGAConfiguration cfg, List<String> uidsToReconnect) Updates the server configuration with the given configuration.

Methods inherited from class java.lang.Object

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

Method Detail

getDatabaseKeys

public Collection<String> getDatabaseKeys()
                                   throws de.innovationgate.webgate.api.WGException

Returns a List of database keys of all OpenWGA databases, including apps and data sources

Throws:

de.innovationgate.webgate.api.WGException

getAppKeys

public Collection<String> getAppKeys()
                              throws de.innovationgate.webgate.api.WGException

Returns a List of database keys of all OpenWGA applications, excluding data sources

Throws:

de.innovationgate.webgate.api.WGException

getDataSourceKeys

public Collection<String> getDataSourceKeys()
                                     throws de.innovationgate.webgate.api.WGException

Returns a List of database keys of all OpenWGA data sources, excluding full applications

Throws:

de.innovationgate.webgate.api.WGException

getDomainNames

public Collection<String> getDomainNames()
                                  throws de.innovationgate.webgate.api.WGException

Returns the names of all OpenWGA domains

Throws:

de.innovationgate.webgate.api.WGException

getLog

public org.apache.log4j.Logger getLog()

Returns the application log logger of the server

getBaseURL

public String getBaseURL()
                  throws de.innovationgate.webgate.api.WGException

Returns the base URL to reach this OpenWGA runtime This is the base part of every OpenWGA URL that is necessary to address the OpenWGA server itself, without any extra path information that is used to address resources within OpenWGA. It is an absolute URL which uses an "best effort" approach to server a matching host name (as an OpenWGA server may listen to many hostnames). When in a normal WebTML environment running on behalf of a request then this URL uses the base URL information from that request. If not then it uses the configured root URL from WGA configuration.

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGException

getConfigFolder

public File getConfigFolder()
                     throws de.innovationgate.webgate.api.WGException

Returns the folder in which is used for WGA configuration Every OpenWGA installation uses a special folder for file data that is managed by the server itself. This contains files like the basic OpenWGA configuration file "wgaconfig.xml", the plugin management folder, folders for internally managed databases etc.

Throws:

de.innovationgate.webgate.api.WGException

resolveSystemFile

public File resolveSystemFile(String fileName)
                       throws de.innovationgate.webgate.api.WGException

Tries to find an "OpenWGA system file" of the given file name or path in the servers file system This method can be used to lookup files related to OpenWGA, no matter if they are specified as complete path or as relative path/name to OpenWGAs config folder. The method will:

• Test if the file name is a complete path and evaluate if a file exists at that path
• Test if the file name is the relative path of a file in OpenWGAs config folder
• Resolve path variables in the file name
• Follow OpenWGA directory links

Parameters:

fileName - Name or path of the file

Returns:

The system file or null if it could not be found

Throws:

de.innovationgate.webgate.api.WGException

getServletContext

public ServletContext getServletContext()
                                 throws de.innovationgate.webgate.api.WGException

Returns the JavaEE servlet context of OpenWGA This object of type javax.servlet.ServletContext is the basic context object of OpenWGA as Java Web Application.

Throws:

de.innovationgate.webgate.api.WGException

getProblemRegistry

public ProblemRegistry getProblemRegistry()

Returns OpenWGAs problem registry

getModuleRegistry

public de.innovationgate.wga.modules.ModuleRegistry getModuleRegistry()
                                                               throws de.innovationgate.webgate.api.WGException

Returns the OpenWGA module registry

Throws:

de.innovationgate.webgate.api.WGException

getLibraryLoader

public de.innovationgate.utils.DynamicClassLoadingChain getLibraryLoader()
                                                                  throws de.innovationgate.webgate.api.WGException

Returns the library class loader used by OpenWGA to load extension classes

Throws:

de.innovationgate.webgate.api.WGException

getVersion

public de.innovationgate.wga.common.beans.csconfig.v1.Version getVersion()
                                                                  throws de.innovationgate.webgate.api.WGException

Returns the WGA server version

Throws:

de.innovationgate.webgate.api.WGException

reloadConfig

public void reloadConfig()
                  throws de.innovationgate.webgate.api.WGException

Reloads the server configuration

Throws:

de.innovationgate.webgate.api.WGException

reloadConfig

public List<String> reloadConfig(List<String> uidsToReconnect)
                          throws de.innovationgate.webgate.api.WGException

Reloads the server configuration, reconnecting the databases belonging to the given config UIDs

Parameters:

uidsToReconnect - UIDs of config entities. Allowed are config UIDs of domains, database servers and content databases, also database keys.

Throws:

de.innovationgate.webgate.api.WGException

updateConfig

public void updateConfig(de.innovationgate.wga.config.WGAConfiguration cfg,
                         List<String> uidsToReconnect)
                  throws de.innovationgate.webgate.api.WGException

Updates the server configuration with the given configuration. Also dropping connections to the databases belonging to the given config UIDs. If the databases are still configured after update of the configuration they will subsequently get connected again.

Parameters:

cfg - The new configuration

uidsToReconnect - UIDs of config entities. Allowed are config UIDs of domains, database servers and content databases, also database keys.

Throws:

de.innovationgate.webgate.api.WGException

updateConfig

public void updateConfig(de.innovationgate.wga.config.WGAConfiguration cfg)
                  throws de.innovationgate.webgate.api.WGException

Updates the server configuration with the given configuration.

Parameters:

cfg - The new configuration

Throws:

de.innovationgate.webgate.api.WGException

reconnect

public List<String> reconnect(List<String> uidsToReconnect)
                       throws de.innovationgate.webgate.api.WGException

Reconnects database belonging to the given config UIDs

Parameters:

uidsToReconnect - UIDs of config entities. Allowed are config UIDs of domains, database servers and content databases, also database keys.

Throws:

de.innovationgate.webgate.api.WGException

performPluginOperations

public void performPluginOperations(List<WorkspaceOperation> ops)
                             throws de.innovationgate.webgate.api.WGException

Performs plugin operations on the current WGA plugin set

Parameters:

ops - List of operations

Throws:

de.innovationgate.webgate.api.WGException

startProblemOccasion

public Server.ServerOccasion startProblemOccasion(Class<?> refClass,
                                                  Object scopeObject,
                                                  String baseKey,
                                                  boolean clear)

Starts a generic problem occasion for OpenWGA non-design-related problems

Parameters:

refClass - The reference class containing the problem-causing code. The problem labels will need to be put into a properties file "ClassName_problems.properties" in its package folder

scopeObject - An object representing the scope of this problem. Allowed are: App, DataSource, Database, WGDatabase, Domain

baseKey - The base key of this problem occasion. The labels of problem keys will start with this base key

clear - Whether old problems of an equal occasion should now be cleared

Returns:

The occasion object

startProblemOccasion

public Server.ServerOccasion startProblemOccasion(Class<?> refClass,
                                                  String baseKey)

Starts a generic problem occasion for OpenWGA non-design-related problems. This method variant creates an occasion of global scope and automatically clears existing problems of equal occasions.

Parameters:

refClass - The reference class containing the problem-causing code. The problem labels will need to be put into a properties file "ClassName_problems.properties" in its package folder

baseKey - The base key of this problem occasion. The labels of problem keys will start with this base key

Returns:

The occasion object

startProblemOccasion

public Server.ServerOccasion startProblemOccasion(Class<?> refClass,
                                                  Object scopeObject,
                                                  String baseKey)

Starts a generic problem occasion for OpenWGA non-design-related problems. This method variant automatically clears existing problems of equal occasions.

Parameters:

refClass - The reference class containing the problem-causing code. The problem labels will need to be put into a properties file "ClassName_problems.properties" in its package folder

scopeObject - An object representing the scope of this problem. Allowed are: App, DataSource, Database, WGDatabase, Domain

baseKey - The base key of this problem occasion. The labels of problem keys will start with this base key

Returns:

The occasion object

startProblemOccasion

public Server.ServerOccasion startProblemOccasion(Class<?> refClass,
                                                  String baseKey,
                                                  boolean clear)

Starts a generic problem occasion for OpenWGA non-design-related problems. This method variant creates an occasion of global scope.

Parameters:

refClass - The reference class containing the problem-causing code. The problem labels will need to be put into a properties file "ClassName_problems.properties" in its package folder

baseKey - The base key of this problem occasion. The labels of problem keys will start with this base key

clear - Whether old problems of an equal occasion should now be cleared

Returns:

The occasion object

getServerOption

public Object getServerOption(String name)

Reads a server option This method returns the server option value in its native data type, like determined in module registry. If the server option is not determined for this runtime this method will return the options default value from the module registry.

Parameters:

name - Name of the server option

Returns:

The native option value

clearAllCaches

public List<String> clearAllCaches()
                            throws de.innovationgate.webgate.api.WGException

Clears all clearable caches on this OpenWGA runtime including:

• Data, user and file publishing caches on all web applications and data sources
• WebTML cache
• TMLScript code cache
• Design file cache

This should be run in a master session. This method will return without doing anything if another thread is already clearing caches.

Returns:

Descriptions of caches whose clearing have raised errors

Throws:

de.innovationgate.webgate.api.WGException