public interface Admin
Modifier and Type | Method and Description |
---|---|
void |
addAdminLinks(java.lang.String name,
Resource resource,
Link[] actions)
Add a group of links to the administration / admin tasks.
|
MessageTemplate |
createMessageTemplate()
Create a new, empty message template.
|
void |
executeTimer(java.lang.String id)
Execute the timer with the given id
|
java.lang.String |
executeUpgrade()
Execute db-upgrades in @enterprise, if db-version is out-of-date.
|
java.lang.String |
exportXML(java.util.List<Exportable> objects,
java.lang.String clustername,
java.lang.String description,
java.util.Set<java.lang.String> skipclasses,
java.io.OutputStream os,
java.io.PrintWriter pw)
Perform an XML Export.
|
java.lang.String |
exportXML(java.lang.String mainclass,
java.lang.String condition,
java.util.List<java.lang.Object> params,
java.lang.String clustername,
java.lang.String description,
java.util.Set<java.lang.String> skipclasses,
boolean mapusers,
java.io.OutputStream os,
java.io.PrintWriter pw)
Perform an XML Export.
|
java.lang.String |
exportXML(java.lang.String mainclass,
java.lang.String condition,
java.util.List<java.lang.Object> params,
java.lang.String clustername,
java.lang.String description,
java.util.Set<java.lang.String> skipclasses,
java.io.OutputStream os,
java.io.PrintWriter pw)
Perform an XML Export.
|
java.lang.String |
fileImport(java.io.File fs,
java.lang.String key)
Method for importing a text file into a database table.
|
void |
generateFormClass(FormType ft)
Generate the classes for the given form type.
|
MessageTemplate |
getMessageTemplate(java.lang.String id)
Read the message template with the given id from the database.
|
java.lang.String |
getServerAdminURL()
returns the url to the admin connector of the web server, the information is maintained in the server object
in the administration.
|
java.lang.String |
getServerURL()
returns the url to the web server, the information is maintained in the server object
in the administration.
|
java.lang.String |
importXML(java.lang.String resource)
Perform an XML-Import.
|
void |
initLogFile()
Initialize the log file (start writing a new one)
|
java.lang.String |
installApplication(java.lang.String destdir,
java.io.File source)
Method for installing an application.
|
boolean |
isLoginAllowed()
Is login ot @ep allowed?
|
void |
refreshWorklistCacheInstances()
Refresh the activities in the worklist cache
|
void |
refreshWorklistCacheOrgData()
Refresh the organizational data in the worklist cache
|
void |
reloadDBConnections()
Marks all Database Connections as old.
|
void |
removeFieldModes(ProcessDefinition pd,
java.lang.String steplabel,
java.lang.String formid,
java.lang.String subformids)
Remove the field modes of a form in a process.
|
void |
replaceHTML(FormType ft,
java.lang.String htmlpage)
Regenerate a form.
|
void |
restartServer()
Restart the @enterprise server
|
void |
sendToAdmin(java.lang.String subject,
java.lang.String message)
Send a message with mime-type text/plain to the system administrator.
|
void |
sendToAdmin(java.lang.String subject,
java.lang.String message,
MailSender.MailAction action)
Send a message with mime-type text/plain to the system administrator.
|
java.lang.String |
serverInfo()
Print out the server information.
|
void |
setFieldModes(ProcessDefinition pd,
java.lang.String steplabel,
java.lang.String formid,
java.lang.String subformids,
java.util.Map<java.lang.String,java.lang.Short> modes)
Set the field mode for a step in a process.
|
void |
setLoginAllowed(java.lang.String nodeid,
boolean allowed,
java.lang.String message)
Allow or deny the login on the given node.
|
void |
setLoginAllowed(java.lang.String nodeid,
boolean allowed,
java.lang.String message,
int currentSessions,
java.lang.String successorNodeId)
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
|
void stopServer()
void restartServer()
void generateFormClass(FormType ft) throws java.lang.Exception
java.lang.Exception
void replaceHTML(FormType ft, java.lang.String htmlpage) throws java.lang.Exception
java.lang.Exception
java.lang.String serverInfo() throws java.lang.Exception
java.lang.Exception
void executeTimer(java.lang.String id) throws java.lang.Exception
java.lang.Exception
void refreshWorklistCacheOrgData()
void refreshWorklistCacheInstances()
void initLogFile()
java.lang.String viewLogFile() throws java.io.IOException
java.io.IOException
boolean isLoginAllowed()
void setLoginAllowed(java.lang.String nodeid, boolean allowed, java.lang.String message) throws java.lang.Exception
nodeid
- id of cluster node, ignored in non-cluster modeallowed
- if true login is allowedmessage
- a message for the users trying to login.java.lang.Exception
void setLoginAllowed(java.lang.String nodeid, boolean allowed, java.lang.String message, int currentSessions, java.lang.String successorNodeId) throws java.lang.Exception
java.lang.Exception
java.lang.String executeUpgrade() throws java.lang.Exception
java.lang.Exception
java.net.URL showClassLocation(java.lang.String cl)
java.lang.String importXML(java.lang.String resource) throws java.lang.Exception
resource
- a resource in the classpathjava.lang.Exception
java.lang.String installApplication(java.lang.String destdir, java.io.File source) throws java.lang.Exception
destdir
- destination directorysource
- the zip file containing the applicationjava.lang.Exception
java.lang.String fileImport(java.io.File fs, java.lang.String key) throws java.lang.Exception
fs
- the file to importkey
- the key referencing the import description. This key has the following syntax: applid:descname
The applid is the id of an application, an import description is searched in the classpath using the path
applid/import.xml, the descname is the name of an import declaration in the file.java.lang.Exception
java.lang.String exportXML(java.lang.String mainclass, java.lang.String condition, java.util.List<java.lang.Object> params, java.lang.String clustername, java.lang.String description, java.util.Set<java.lang.String> skipclasses, java.io.OutputStream os, java.io.PrintWriter pw) throws java.lang.Exception
mainclass
- export elements of this classcondition
- restriction for mainclassparams
- parameter of the conditionclustername
- refers to a cluster in SchemaDescription contains a list of classes to exportdescription
- description for export fileskipclasses
- do not export member of these classesos
- write the export to this streampw
- write the log to this writerjava.lang.Exception
java.lang.String exportXML(java.lang.String mainclass, java.lang.String condition, java.util.List<java.lang.Object> params, java.lang.String clustername, java.lang.String description, java.util.Set<java.lang.String> skipclasses, boolean mapusers, java.io.OutputStream os, java.io.PrintWriter pw) throws java.lang.Exception
mainclass
- export elements of this classcondition
- restriction for mainclassparams
- parameter of the conditionclustername
- refers to a cluster in SchemaDescription contains a list of classes to exportdescription
- description for export fileskipclasses
- do not export member of these classesmapusers
- map referenced users to user "sysadm", if true
os
- write the export to this streampw
- write the log to this writerjava.lang.Exception
java.lang.String exportXML(java.util.List<Exportable> objects, java.lang.String clustername, java.lang.String description, java.util.Set<java.lang.String> skipclasses, java.io.OutputStream os, java.io.PrintWriter pw) throws java.lang.Exception
objects
- a homogenous list of objects of an exportable classclustername
- refers to a cluster in SchemaDescription contains a list of classes to exportdescription
- description for export fileskipclasses
- do not export member of these classesos
- write the export to this streampw
- write the log to this writerjava.lang.Exception
java.lang.String getServerURL()
java.lang.String getServerAdminURL()
void reloadDBConnections()
void setFieldModes(ProcessDefinition pd, java.lang.String steplabel, java.lang.String formid, java.lang.String subformids, java.util.Map<java.lang.String,java.lang.Short> modes)
pd
- the process definition object, mandatorysteplabel
- the label of the step, mandatoryformid
- the id of the form, mandatorysubformids
- the key for subforms: If the modes of a subform are set, this parameter
contains the subforms id(s) separated be a slash. Example: the form f has a subform g with id 1, g has a subform
h with id 3, the parameter subformids should have the value "1/3" if setting the field values of form h.
If the modes of a mainform are set the parameters is either "0" or may be null.modes
- The modes map is a map of fieldnames and mode values. See the constants in WfEngine for the value range.
The field names are either the java field names of the form class of the classname and id of the subform, separated
by a space.void removeFieldModes(ProcessDefinition pd, java.lang.String steplabel, java.lang.String formid, java.lang.String subformids)
pd
- the process definition object, mandatorysteplabel
- the steplabel, may be nullformid
- id of the form in the process, mandatorysubformids
- syntax as in setFieldModes, null means all form fields of the form (and step) are deleted.void addAdminLinks(java.lang.String name, Resource resource, Link[] actions)
name
- the name of the admin groupresource
- the resource to use for i18nactions
- the admin actions to addMessageTemplate getMessageTemplate(java.lang.String id)
id
- id of a message templateMessageTemplate createMessageTemplate()
void sendToAdmin(java.lang.String subject, java.lang.String message)
subject
- the subjectmessage
- the messagevoid sendToAdmin(java.lang.String subject, java.lang.String message, MailSender.MailAction action)
subject
- the subjectmessage
- the messagemessage
- the MailSender.MailAction
, if null
the configured setting of property "ep.mail.queue.usage" is taken@enterprise 9.0.33982 Copyright © 2001-2023 Groiss Informatics GmbH. All Rights Reserved.