de.innovationgate.wgaservices

Interface WGACoreServices

All Superinterfaces:

WGAServices

public interface WGACoreServices
extends WGAServices

internal wga service interface

Method Summary

Methods

Modifier and Type	Method and Description
void	activatePlugin(RemoteSession session, PluginInfo pluginInfo) activates the specified plugin
RemoteSession	adminLogin(String user, String pwd) Logs in to the WGA server as WGA administrator.
DataSource	createContentStoreDump(RemoteSession session, String dbKey, boolean includeACL) creates a content store dump of the given database
DataSource	createContentStoreDump(RemoteSession session, String dbKey, boolean includeACL, boolean includeSystemAreas) creates a content store dump of the given database
void	createDatabase(RemoteSession session, DatabaseServerInfo dbServerInfo, String implClassName, Map<String,String> options) creates a content store on the given database server with the given name this operation will only create the database and not modify the OpenWGA configuration
void	deactivatePlugin(RemoteSession session, PluginInfo pluginInfo) deactivates the specified plugin fails silently if the plugin is already disabled
void	deleteFSDesignResource(RemoteSession session, String path) deletes the given design resource
DataSource	downloadPlugin(RemoteSession session, PluginInfo pluginInfo) retrieves the plugin file of the specified plugin
List<DatabaseInformation>	getAvailableDatabases(RemoteSession session, DatabaseServerInfo dbServerInfo, String implClassName) retrieves a list of available databases on given server with given type
List<String>	getConnectedContentDatabases(RemoteSession session) returns a list of dbkeys of current connected content databases
String	getDesignPath(RemoteSession session, String dbKey) Returns the design path of the given database 'null' if database has no file system based design
List<PluginInfo>	getPluginInformation(RemoteSession session) returns information about currently installed plugins
DataSource	getWGAConfiguration(RemoteSession session) retrieves the current wga configuration
Version	getWGAVersion(RemoteSession session) returns the version of wga
void	importContentStoreDump(RemoteSession session, DataSource csDump, String dbKey, boolean includeACL) imports the given content store dump in the database specified by dbKey
void	importContentStoreDump(RemoteSession session, DataSource csDump, String dbKey, boolean includeACL, boolean includeSystemAreas) imports the given content store dump in the database specified by dbKey
void	initializeOverlay(RemoteSession session, PluginInfo pluginInfo, String designFolder) performs an overlay initialization or update on the given plugin with the given design folder
void	installPlugins(RemoteSession session, List<DataSource> plugins) installs the given list of plugin files
boolean	isTMLScriptDebuggerEnabled(RemoteSession session) returns the state of the tmlscript debugger
boolean	isWebTMLCachingEnabled(RemoteSession session) Returns the state of WebTML caching
void	mkFSDesignDir(RemoteSession session, String path) creates the given design directory
List<DatabaseServerInfo>	retrieveContentStoreDatabaseServers(RemoteSession session) retrieves a list of available database servers of the current OpenWGA runtime which are able to provide content stores
DataSource	retrieveFSDesignResourceContent(RemoteSession session, FSDesignResourceState state) retrieves the content of the given file system design resource
List<FSDesignResourceState>	retrieveFSDesignResourceState(RemoteSession session, String path) retrieves the file system design resource states for the given path
void	setTMLScriptDebuggerEnabled(RemoteSession session, boolean enabled) enables or disables the tmlscript debugger
void	setWebTMLCachingEnabled(RemoteSession session, boolean enabled) Enables or disables WebTML caching functionality globally
void	updateFSDesignResource(RemoteSession session, String path, DataSource content, long lastModified) updates/ overwrites the given design resource with the new content
void	updateWGAConfiguration(RemoteSession session, DataSource wgaConfiguration) update the current wga configuration

Methods inherited from interface de.innovationgate.wgaservices.WGAServices

callAction, getAccessLevel, login

Method Detail

adminLogin

RemoteSession adminLogin(String user,
                       String pwd)
                         throws WGAServiceException

Logs in to the WGA server as WGA administrator. An administrator login can do all tasks on the server under master login. Usage of an administrator login is restricted to the administrative port if that is configured.

Parameters:

user - The administrator user

pwd - The administrator password

Returns:

A remote session object for the administrator

Throws:

WGAServiceException

getDesignPath

String getDesignPath(RemoteSession session,
                   String dbKey)
                     throws WGAServiceException

Returns the design path of the given database 'null' if database has no file system based design

Parameters:

session - The session to use

dbKey - The dbkey

Returns:

design path of given db or 'null'

Throws:

WGAServiceException

installPlugins

void installPlugins(RemoteSession session,
                  List<DataSource> plugins)
                    throws WGAServiceException

installs the given list of plugin files

Parameters:

session -

plugins -

Throws:

WGAServiceException

retrieveFSDesignResourceState

List<FSDesignResourceState> retrieveFSDesignResourceState(RemoteSession session,
                                                        String path)
                                                          throws WGAServiceException

retrieves the file system design resource states for the given path

Parameters:

session -

path - - a '/' separated path rooted at the default FSDesignProvider root

Returns:

the FSDesignResourceStates

Throws:

WGAServiceException

retrieveFSDesignResourceContent

DataSource retrieveFSDesignResourceContent(RemoteSession session,
                                         FSDesignResourceState state)
                                           throws WGAServiceException

retrieves the content of the given file system design resource

Parameters:

session -

state -

Throws:

WGAServiceException

updateFSDesignResource

void updateFSDesignResource(RemoteSession session,
                          String path,
                          DataSource content,
                          long lastModified)
                            throws WGAServiceException

updates/ overwrites the given design resource with the new content

Parameters:

session -

path -

content -

Throws:

WGAServiceException

deleteFSDesignResource

void deleteFSDesignResource(RemoteSession session,
                          String path)
                            throws WGAServiceException

deletes the given design resource

Parameters:

session -

path -

Throws:

WGAServiceException

mkFSDesignDir

void mkFSDesignDir(RemoteSession session,
                 String path)
                   throws WGAServiceException

creates the given design directory

Parameters:

session -

path -

Throws:

WGAServiceException

getWGAConfiguration

DataSource getWGAConfiguration(RemoteSession session)
                               throws WGAServiceException

retrieves the current wga configuration

Parameters:

session -

Throws:

WGAServiceException

updateWGAConfiguration

void updateWGAConfiguration(RemoteSession session,
                          DataSource wgaConfiguration)
                            throws WGAServiceException

update the current wga configuration

Parameters:

session -

Throws:

WGAServiceException

retrieveContentStoreDatabaseServers

List<DatabaseServerInfo> retrieveContentStoreDatabaseServers(RemoteSession session)
                                                             throws WGAServiceException

retrieves a list of available database servers of the current OpenWGA runtime which are able to provide content stores

Parameters:

session -

Throws:

WGAServiceException

createDatabase

void createDatabase(RemoteSession session,
                  DatabaseServerInfo dbServerInfo,
                  String implClassName,
                  Map<String,String> options)
                    throws WGAServiceException

creates a content store on the given database server with the given name this operation will only create the database and not modify the OpenWGA configuration

Parameters:

session -

dbServerInfo -

implClassName -

options -

Throws:

WGAServiceException

importContentStoreDump

void importContentStoreDump(RemoteSession session,
                          DataSource csDump,
                          String dbKey,
                          boolean includeACL)
                            throws WGAServiceException

imports the given content store dump in the database specified by dbKey

Parameters:

session -

dbKey -

Throws:

WGAServiceException

createContentStoreDump

DataSource createContentStoreDump(RemoteSession session,
                                String dbKey,
                                boolean includeACL)
                                  throws WGAServiceException

creates a content store dump of the given database

Parameters:

session -

dbKey -

includeACL -

Throws:

WGAServiceException

importContentStoreDump

void importContentStoreDump(RemoteSession session,
                          DataSource csDump,
                          String dbKey,
                          boolean includeACL,
                          boolean includeSystemAreas)
                            throws WGAServiceException

imports the given content store dump in the database specified by dbKey

Parameters:

session -

dbKey -

includeACL -

includeSystemAreas -

Throws:

WGAServiceException

createContentStoreDump

DataSource createContentStoreDump(RemoteSession session,
                                String dbKey,
                                boolean includeACL,
                                boolean includeSystemAreas)
                                  throws WGAServiceException

creates a content store dump of the given database

Parameters:

session -

dbKey -

includeACL -

includeSystemAreas -

Throws:

WGAServiceException

getAvailableDatabases

List<DatabaseInformation> getAvailableDatabases(RemoteSession session,
                                              DatabaseServerInfo dbServerInfo,
                                              String implClassName)
                                                throws WGAServiceException

retrieves a list of available databases on given server with given type

Parameters:

session -

dbServerInfo -

implClassName -

Throws:

WGAServiceException

getPluginInformation

List<PluginInfo> getPluginInformation(RemoteSession session)
                                      throws WGAServiceException

returns information about currently installed plugins

Parameters:

session -

Throws:

WGAServiceException

getWGAVersion

Version getWGAVersion(RemoteSession session)
                      throws WGAServiceException

returns the version of wga

Parameters:

session -

Throws:

WGAServiceException

downloadPlugin

DataSource downloadPlugin(RemoteSession session,
                        PluginInfo pluginInfo)
                          throws WGAServiceException

retrieves the plugin file of the specified plugin

Parameters:

session -

pluginInfo -

Throws:

WGAServiceException

activatePlugin

void activatePlugin(RemoteSession session,
                  PluginInfo pluginInfo)
                    throws WGAServiceException

activates the specified plugin

Parameters:

session -

pluginInfo -

Throws:

WGAServiceException

deactivatePlugin

void deactivatePlugin(RemoteSession session,
                    PluginInfo pluginInfo)
                      throws WGAServiceException

deactivates the specified plugin fails silently if the plugin is already disabled

Parameters:

session -

pluginInfo -

Throws:

WGAServiceException

getConnectedContentDatabases

List<String> getConnectedContentDatabases(RemoteSession session)
                                          throws WGAServiceException

returns a list of dbkeys of current connected content databases

Parameters:

session -

Throws:

WGAServiceException

initializeOverlay

void initializeOverlay(RemoteSession session,
                     PluginInfo pluginInfo,
                     String designFolder)
                       throws WGAServiceException

performs an overlay initialization or update on the given plugin with the given design folder

Parameters:

session -

pluginInfo -

designFolder -

Throws:

WGAServiceException

setTMLScriptDebuggerEnabled

void setTMLScriptDebuggerEnabled(RemoteSession session,
                               boolean enabled)
                                 throws WGAServiceException

enables or disables the tmlscript debugger

Parameters:

enabled -

Throws:

WGAServiceException

isTMLScriptDebuggerEnabled

boolean isTMLScriptDebuggerEnabled(RemoteSession session)
                                   throws WGAServiceException

returns the state of the tmlscript debugger

Throws:

WGAServiceException

setWebTMLCachingEnabled

void setWebTMLCachingEnabled(RemoteSession session,
                           boolean enabled)
                             throws WGAServiceException

Enables or disables WebTML caching functionality globally

Parameters:

session -

enabled -

Throws:

WGAServiceException

isWebTMLCachingEnabled

boolean isWebTMLCachingEnabled(RemoteSession session)
                               throws WGAServiceException

Returns the state of WebTML caching

Parameters:

session -

Throws:

WGAServiceException