com.groiss.server
Interface Admin

public interface Admin

Interface for administrative actions. Use ServiceLocator.getAdmin() to create an instance of this interface.

Method Summary

void	executeTimer(java.lang.String id) Execute the timer with the given id
java.lang.String	importXML(java.lang.String resource) Perform an XML-Import.
java.lang.String	importXML(java.lang.String resource, java.util.List<Persistent> defaultObjects) Perform an XML-Import.
void	initLogFile() Initialize the log file (start writing a new one)
void	refreshWorklistCacheInstances() Refresh the activities in the worklist cache
void	refreshWorklistCacheOrgData() Refresh the organizational data in the worklist cache
void	replaceHTML(FormType ft, java.lang.String htmlpage) Regenerate a form.
void	restartServer() Restart the @enterprise server
java.lang.String	serverInfo() Print out the server information.
void	setLoginAllowed(java.lang.String nodeid, boolean allowed, java.lang.String message) Allow or deny the login on the given node.
java.net.URL	showClassLocation(java.lang.String cl) Search the resource in the classpath.
void	stopServer() Stop the @enterprise server
java.lang.String	viewLogFile() View the current log file

Method Detail

stopServer

void stopServer()

Stop the @enterprise server

restartServer

void restartServer()

Restart the @enterprise server

replaceHTML

void replaceHTML(FormType ft,
                 java.lang.String htmlpage)
                 throws java.lang.Exception

Regenerate a form. In case of HTML forms the second argument contains the HTML text for this form, in case of XHTML forms the second argument is ignored. The functions recreates the form classes and adds or drop fields to the form table if necessary. Note that the type of new form fields must be provided in the html text (attributes dbtype and dblength).

Throws:

java.lang.Exception

serverInfo

java.lang.String serverInfo()
                            throws java.lang.Exception

Print out the server information.

Throws:

java.lang.Exception

executeTimer

void executeTimer(java.lang.String id)
                  throws java.lang.Exception

Execute the timer with the given id

Throws:

java.lang.Exception

refreshWorklistCacheOrgData

void refreshWorklistCacheOrgData()

Refresh the organizational data in the worklist cache

refreshWorklistCacheInstances

void refreshWorklistCacheInstances()
                                   throws java.lang.Exception

Refresh the activities in the worklist cache

Throws:

java.lang.Exception

initLogFile

void initLogFile()
                 throws java.lang.Exception

Initialize the log file (start writing a new one)

Throws:

java.lang.Exception

viewLogFile

java.lang.String viewLogFile()
                             throws java.lang.Exception

View the current log file

Throws:

java.lang.Exception

setLoginAllowed

void setLoginAllowed(java.lang.String nodeid,
                     boolean allowed,
                     java.lang.String message)
                     throws java.lang.Exception

Allow or deny the login on the given node.

Throws:

java.lang.Exception

showClassLocation

java.net.URL showClassLocation(java.lang.String cl)

Search the resource in the classpath.

importXML

java.lang.String importXML(java.lang.String resource)
                           throws java.lang.Exception

Perform an XML-Import.

Parameters:

resource - a resource in the classpath

Returns:

the log information is returned

Throws:

java.lang.Exception

importXML

java.lang.String importXML(java.lang.String resource,
                           java.util.List<Persistent> defaultObjects)
                           throws java.lang.Exception

Perform an XML-Import. If the xml file contains references to objects not in the file, the corresponding object from the list defaultObjects is used. For example, if the file contains a process definition the defaultObjects list should contain an application object.

Parameters:

resource - a resource in the classpath

list - of default objects.

Returns:

the log information is returned

Throws:

java.lang.Exception