org.dspace.xmlworkflow

Class WorkflowUtils

java.lang.Object

org.dspace.app.util.Util

org.dspace.xmlworkflow.WorkflowUtils

public class WorkflowUtils
extends Util

Utilty methods for the xml workflow

Author:

Bram De Schouwer (bram.deschouwer at dot com), Kevin Van de Velde (kevin at atmire dot com), Ben Bosman (ben at atmire dot com), Mark Diggory (markd at atmire dot com)

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log log4j category

Constructor Summary

Constructors

Constructor and Description
WorkflowUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	createCollectionWorkflowRole(Context context, int collectionId, java.lang.String roleId, Group group) WORKFLOW ROLE MANAGEMENT
static void	deleteRoleGroup(Context context, Collection collection, java.lang.String roleID)
static java.util.HashMap<java.lang.String,Role>	getAllExternalRoles(Collection thisCollection)
static java.util.HashMap<java.lang.String,Role>	getCollectionAndRepositoryRoles(Collection thisCollection)
static java.util.HashMap<java.lang.String,Role>	getCollectionRoles(Collection thisCollection)
static java.lang.String	getOriginalURL(javax.servlet.http.HttpServletRequest request) Get the original request URL.
static java.lang.String	getRequestLogInfo(javax.servlet.http.HttpServletRequest request) Return a string for logging, containing useful information about the current request - the URL, the method and parameters.
static Group	getRoleGroup(Context context, int collectionId, Role role)
static void	sendAlert(javax.servlet.http.HttpServletRequest request, java.lang.Exception exception) Send an alert to the designated "alert recipient" - that is, when a database error or internal error occurs, this person is sent an e-mail with details.
static void	storeOriginalURL(javax.servlet.http.HttpServletRequest request) Put the original request URL into the request object as an attribute for later use.

Methods inherited from class org.dspace.app.util.Util

encodeBitstreamName, encodeBitstreamName, formatFileSize, getBoolParameter, getControlledVocabulariesDisplayValueLocalized, getIntParameter, getIntParameters, getSourceVersion, getSubmitButton, nonBreakSpace

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

log4j category

Constructor Detail

WorkflowUtils

public WorkflowUtils()

Method Detail

getRequestLogInfo

public static java.lang.String getRequestLogInfo(javax.servlet.http.HttpServletRequest request)

Return a string for logging, containing useful information about the current request - the URL, the method and parameters.

Parameters:

request - the request object.

Returns:

a multi-line string containing information about the request.

getOriginalURL

public static java.lang.String getOriginalURL(javax.servlet.http.HttpServletRequest request)

Get the original request URL.

Parameters:

request - the HTTP request

Returns:

the original request URL

storeOriginalURL

public static void storeOriginalURL(javax.servlet.http.HttpServletRequest request)

Put the original request URL into the request object as an attribute for later use. This is necessary because forwarding a request removes this information. The attribute is only written if it hasn't been before; thus it can be called after a forward safely.

Parameters:

request - the HTTP request

sendAlert

public static void sendAlert(javax.servlet.http.HttpServletRequest request,
             java.lang.Exception exception)

Send an alert to the designated "alert recipient" - that is, when a database error or internal error occurs, this person is sent an e-mail with details.

The recipient is configured via the "alert.recipient" property in dspace.cfg. If this property is omitted, no alerts are sent.

This method "swallows" any exception that might occur - it will just be logged. This is because this method will usually be invoked as part of an error handling routine anyway.

Parameters:

request - the HTTP request leading to the error

exception - the exception causing the error, or null

createCollectionWorkflowRole

public static void createCollectionWorkflowRole(Context context,
                                int collectionId,
                                java.lang.String roleId,
                                Group group)
                                         throws AuthorizeException,
                                                java.sql.SQLException

WORKFLOW ROLE MANAGEMENT

Throws:

AuthorizeException

java.sql.SQLException

deleteRoleGroup

public static void deleteRoleGroup(Context context,
                   Collection collection,
                   java.lang.String roleID)
                            throws java.sql.SQLException,
                                   java.io.IOException,
                                   WorkflowConfigurationException

Throws:

java.sql.SQLException

java.io.IOException

WorkflowConfigurationException

getCollectionRoles

public static java.util.HashMap<java.lang.String,Role> getCollectionRoles(Collection thisCollection)
                                                                   throws java.io.IOException,
                                                                          WorkflowConfigurationException

Throws:

java.io.IOException

WorkflowConfigurationException

getCollectionAndRepositoryRoles

public static java.util.HashMap<java.lang.String,Role> getCollectionAndRepositoryRoles(Collection thisCollection)
                                                                                throws java.io.IOException,
                                                                                       WorkflowConfigurationException

Throws:

java.io.IOException

WorkflowConfigurationException

getAllExternalRoles

public static java.util.HashMap<java.lang.String,Role> getAllExternalRoles(Collection thisCollection)
                                                                    throws java.io.IOException,
                                                                           WorkflowConfigurationException

Throws:

java.io.IOException

WorkflowConfigurationException

getRoleGroup

public static Group getRoleGroup(Context context,
                 int collectionId,
                 Role role)
                          throws java.sql.SQLException

Throws:

java.sql.SQLException