org.ofbiz.service
Class ServiceUtil

java.lang.Object
  org.ofbiz.service.ServiceUtil

public class ServiceUtil
extends java.lang.Object

Generic Service Utility Class

Field Summary

static java.lang.String	module
static java.lang.String	resource

Constructor Summary

ServiceUtil()

Method Summary

static void	addErrors(java.util.List<java.lang.Object> targetList, java.util.Map<java.lang.String,java.lang.Object> targetMap, java.util.Map<java.lang.String,? extends java.lang.Object> callResult) Takes the result of an invocation and extracts any error messages and adds them to the targetList or targetMap.
static java.util.Map<java.lang.String,java.lang.Object>	cancelJob(DispatchContext dctx, java.util.Map<java.lang.String,? extends java.lang.Object> context)
static java.util.Map<java.lang.String,java.lang.Object>	cancelJobRetries(DispatchContext dctx, java.util.Map<java.lang.String,? extends java.lang.Object> context)
static java.util.Map<java.lang.String,java.lang.Object>	genericDateCondition(DispatchContext dctx, java.util.Map<java.lang.String,? extends java.lang.Object> context)
static java.lang.String	getErrorMessage(java.util.Map<java.lang.String,? extends java.lang.Object> result)
static void	getMessages(HttpServletRequest request, java.util.Map<java.lang.String,? extends java.lang.Object> result, java.lang.String defaultMessage)
static void	getMessages(HttpServletRequest request, java.util.Map<java.lang.String,? extends java.lang.Object> result, java.lang.String defaultMessage, java.lang.String msgPrefix, java.lang.String msgSuffix, java.lang.String errorPrefix, java.lang.String errorSuffix, java.lang.String successPrefix, java.lang.String successSuffix)
static java.lang.String	getPartyIdCheckSecurity(GenericValue userLogin, Security security, java.util.Map<java.lang.String,? extends java.lang.Object> context, java.util.Map<java.lang.String,java.lang.Object> result, java.lang.String secEntity, java.lang.String secOperation) A small routine used all over to improve code efficiency, get the partyId and does a security check security check: userLogin partyId must equal partyId, or must have [secEntity][secOperation] permission
static GenericValue	getUserLogin(DispatchContext dctx, java.util.Map<java.lang.String,? extends java.lang.Object> context, java.lang.String runAsUser)
static boolean	isError(java.util.Map<java.lang.String,? extends java.lang.Object> results) A little short-cut method to check to see if a service returned an error
static boolean	isFailure(java.util.Map<java.lang.String,? extends java.lang.Object> results)
static <T> java.util.Map<java.lang.String,java.lang.Object>	makeContext(T... args)
static java.lang.String	makeErrorMessage(java.util.Map<java.lang.String,? extends java.lang.Object> result, java.lang.String msgPrefix, java.lang.String msgSuffix, java.lang.String errorPrefix, java.lang.String errorSuffix)
static java.lang.String	makeMessageList(java.util.List<? extends java.lang.Object> msgList, java.lang.String msgPrefix, java.lang.String msgSuffix)
static java.lang.String	makeSuccessMessage(java.util.Map<java.lang.String,? extends java.lang.Object> result, java.lang.String msgPrefix, java.lang.String msgSuffix, java.lang.String successPrefix, java.lang.String successSuffix)
static java.util.Map<java.lang.String,java.lang.Object>	purgeOldJobs(DispatchContext dctx, java.util.Map<java.lang.String,? extends java.lang.Object> context)
static java.util.Map<java.lang.String,java.lang.Object>	resetJob(DispatchContext dctx, java.util.Map<java.lang.String,java.lang.Object> context)
static java.util.Map<java.lang.String,java.lang.Object>	returnError(java.util.List<? extends java.lang.Object> errorMessageList) A small routine used all over to improve code efficiency, make a result map with the message and the error response code
static java.util.Map<java.lang.String,java.lang.Object>	returnError(java.lang.String errorMessage) A small routine used all over to improve code efficiency, make a result map with the message and the error response code
static java.util.Map<java.lang.String,java.lang.Object>	returnError(java.lang.String errorMessage, java.util.List<? extends java.lang.Object> errorMessageList) A small routine used all over to improve code efficiency, make a result map with the message and the error response code
static java.util.Map<java.lang.String,java.lang.Object>	returnError(java.lang.String errorMessage, java.util.List<? extends java.lang.Object> errorMessageList, java.util.Map<java.lang.String,? extends java.lang.Object> errorMessageMap, java.util.Map<java.lang.String,? extends java.lang.Object> nestedResult) A small routine used all over to improve code efficiency, make a result map with the message and the error response code, also forwards any error messages from the nestedResult
static java.util.Map<java.lang.String,java.lang.Object>	returnFailure()
static java.util.Map<java.lang.String,java.lang.Object>	returnFailure(java.util.List<? extends java.lang.Object> errorMessageList)
static java.util.Map<java.lang.String,java.lang.Object>	returnFailure(java.lang.String errorMessage)
static java.util.Map<java.lang.String,java.lang.Object>	returnMessage(java.lang.String code, java.lang.String message) A small routine to make a result map with the message and the response code NOTE: This brings out some bad points to our message convention: we should be using a single message or message list and what type of message that is should be determined by the RESPONSE_MESSAGE (and there's another annoyance, it should be RESPONSE_CODE)
static java.util.Map<java.lang.String,java.lang.Object>	returnProblem(java.lang.String returnType, java.lang.String errorMessage, java.util.List<? extends java.lang.Object> errorMessageList, java.util.Map<java.lang.String,? extends java.lang.Object> errorMessageMap, java.util.Map<java.lang.String,? extends java.lang.Object> nestedResult)
static java.util.Map<java.lang.String,java.lang.Object>	returnSuccess() A small routine used all over to improve code efficiency, make a result map with the message and the success response code
static java.util.Map<java.lang.String,java.lang.Object>	returnSuccess(java.lang.String successMessage) A small routine used all over to improve code efficiency, make a result map with the message and the success response code
static void	setMessages(HttpServletRequest request, java.lang.String errorMessage, java.lang.String eventMessage, java.lang.String defaultMessage)

Methods inherited from class java.lang.Object

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

Field Detail

module

public static final java.lang.String module

resource

public static final java.lang.String resource

See Also:

Constant Field Values

Constructor Detail

ServiceUtil

public ServiceUtil()

Method Detail

isError

public static boolean isError(java.util.Map<java.lang.String,? extends java.lang.Object> results)

A little short-cut method to check to see if a service returned an error

isFailure

public static boolean isFailure(java.util.Map<java.lang.String,? extends java.lang.Object> results)

returnError

public static java.util.Map<java.lang.String,java.lang.Object> returnError(java.lang.String errorMessage)

A small routine used all over to improve code efficiency, make a result map with the message and the error response code

returnError

public static java.util.Map<java.lang.String,java.lang.Object> returnError(java.lang.String errorMessage,
                                                                           java.util.List<? extends java.lang.Object> errorMessageList)

A small routine used all over to improve code efficiency, make a result map with the message and the error response code

returnError

public static java.util.Map<java.lang.String,java.lang.Object> returnError(java.util.List<? extends java.lang.Object> errorMessageList)

A small routine used all over to improve code efficiency, make a result map with the message and the error response code

returnFailure

public static java.util.Map<java.lang.String,java.lang.Object> returnFailure(java.lang.String errorMessage)

returnFailure

public static java.util.Map<java.lang.String,java.lang.Object> returnFailure(java.util.List<? extends java.lang.Object> errorMessageList)

returnFailure

public static java.util.Map<java.lang.String,java.lang.Object> returnFailure()

returnError

public static java.util.Map<java.lang.String,java.lang.Object> returnError(java.lang.String errorMessage,
                                                                           java.util.List<? extends java.lang.Object> errorMessageList,
                                                                           java.util.Map<java.lang.String,? extends java.lang.Object> errorMessageMap,
                                                                           java.util.Map<java.lang.String,? extends java.lang.Object> nestedResult)

A small routine used all over to improve code efficiency, make a result map with the message and the error response code, also forwards any error messages from the nestedResult

returnProblem

public static java.util.Map<java.lang.String,java.lang.Object> returnProblem(java.lang.String returnType,
                                                                             java.lang.String errorMessage,
                                                                             java.util.List<? extends java.lang.Object> errorMessageList,
                                                                             java.util.Map<java.lang.String,? extends java.lang.Object> errorMessageMap,
                                                                             java.util.Map<java.lang.String,? extends java.lang.Object> nestedResult)

returnSuccess

public static java.util.Map<java.lang.String,java.lang.Object> returnSuccess(java.lang.String successMessage)

A small routine used all over to improve code efficiency, make a result map with the message and the success response code

returnSuccess

public static java.util.Map<java.lang.String,java.lang.Object> returnSuccess()

A small routine used all over to improve code efficiency, make a result map with the message and the success response code

returnMessage

public static java.util.Map<java.lang.String,java.lang.Object> returnMessage(java.lang.String code,
                                                                             java.lang.String message)

A small routine to make a result map with the message and the response code NOTE: This brings out some bad points to our message convention: we should be using a single message or message list and what type of message that is should be determined by the RESPONSE_MESSAGE (and there's another annoyance, it should be RESPONSE_CODE)

getPartyIdCheckSecurity

public static java.lang.String getPartyIdCheckSecurity(GenericValue userLogin,
                                                       Security security,
                                                       java.util.Map<java.lang.String,? extends java.lang.Object> context,
                                                       java.util.Map<java.lang.String,java.lang.Object> result,
                                                       java.lang.String secEntity,
                                                       java.lang.String secOperation)

A small routine used all over to improve code efficiency, get the partyId and does a security check security check: userLogin partyId must equal partyId, or must have [secEntity][secOperation] permission

setMessages

public static void setMessages(HttpServletRequest request,
                               java.lang.String errorMessage,
                               java.lang.String eventMessage,
                               java.lang.String defaultMessage)

getMessages

public static void getMessages(HttpServletRequest request,
                               java.util.Map<java.lang.String,? extends java.lang.Object> result,
                               java.lang.String defaultMessage)

getMessages

public static void getMessages(HttpServletRequest request,
                               java.util.Map<java.lang.String,? extends java.lang.Object> result,
                               java.lang.String defaultMessage,
                               java.lang.String msgPrefix,
                               java.lang.String msgSuffix,
                               java.lang.String errorPrefix,
                               java.lang.String errorSuffix,
                               java.lang.String successPrefix,
                               java.lang.String successSuffix)

getErrorMessage

public static java.lang.String getErrorMessage(java.util.Map<java.lang.String,? extends java.lang.Object> result)

makeErrorMessage

public static java.lang.String makeErrorMessage(java.util.Map<java.lang.String,? extends java.lang.Object> result,
                                                java.lang.String msgPrefix,
                                                java.lang.String msgSuffix,
                                                java.lang.String errorPrefix,
                                                java.lang.String errorSuffix)

makeSuccessMessage

public static java.lang.String makeSuccessMessage(java.util.Map<java.lang.String,? extends java.lang.Object> result,
                                                  java.lang.String msgPrefix,
                                                  java.lang.String msgSuffix,
                                                  java.lang.String successPrefix,
                                                  java.lang.String successSuffix)

makeMessageList

public static java.lang.String makeMessageList(java.util.List<? extends java.lang.Object> msgList,
                                               java.lang.String msgPrefix,
                                               java.lang.String msgSuffix)

addErrors

public static void addErrors(java.util.List<java.lang.Object> targetList,
                             java.util.Map<java.lang.String,java.lang.Object> targetMap,
                             java.util.Map<java.lang.String,? extends java.lang.Object> callResult)

Takes the result of an invocation and extracts any error messages and adds them to the targetList or targetMap. This will handle both List and String error messags.

Parameters:

targetList - The List to add the error messages to

targetMap - The Map to add any Map error messages to

callResult - The result from an invocation

purgeOldJobs

public static java.util.Map<java.lang.String,java.lang.Object> purgeOldJobs(DispatchContext dctx,
                                                                            java.util.Map<java.lang.String,? extends java.lang.Object> context)

cancelJob

public static java.util.Map<java.lang.String,java.lang.Object> cancelJob(DispatchContext dctx,
                                                                         java.util.Map<java.lang.String,? extends java.lang.Object> context)

cancelJobRetries

public static java.util.Map<java.lang.String,java.lang.Object> cancelJobRetries(DispatchContext dctx,
                                                                                java.util.Map<java.lang.String,? extends java.lang.Object> context)

genericDateCondition

public static java.util.Map<java.lang.String,java.lang.Object> genericDateCondition(DispatchContext dctx,
                                                                                    java.util.Map<java.lang.String,? extends java.lang.Object> context)

getUserLogin

public static GenericValue getUserLogin(DispatchContext dctx,
                                        java.util.Map<java.lang.String,? extends java.lang.Object> context,
                                        java.lang.String runAsUser)

makeContext

public static <T> java.util.Map<java.lang.String,java.lang.Object> makeContext(T... args)

resetJob

public static java.util.Map<java.lang.String,java.lang.Object> resetJob(DispatchContext dctx,
                                                                        java.util.Map<java.lang.String,java.lang.Object> context)