ActionUtil (pentaho-platform-core 8.0.0.0-6 API)

java.lang.Object
- org.pentaho.platform.util.ActionUtil

```
public class ActionUtil
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`INVOKER_ACTIONCLASS`
`static String`	`INVOKER_ACTIONID`
`static String`	`INVOKER_ACTIONPARAMS`
`static String`	`INVOKER_ACTIONUSER`
`static String`	`INVOKER_ASYNC_EXEC`
`static String`	`INVOKER_DEFAULT_ASYNC_EXEC_VALUE`
`static String`	`INVOKER_RESTART_FLAG`
`static String`	`INVOKER_SESSION`
`static String`	`INVOKER_STREAMPROVIDER`
`static String`	`INVOKER_STREAMPROVIDER_INPUT_FILE`
`static String`	`INVOKER_STREAMPROVIDER_OUTPUT_FILE_PATTERN`
`static String`	`INVOKER_STREAMPROVIDER_UNIQUE_FILE_NAME`
`static String`	`INVOKER_SYNC_VALUE`
`static String`	`INVOKER_UIPASSPARAM`
`static String`	`QUARTZ_ACTIONCLASS`
`static String`	`QUARTZ_ACTIONID`
`static String`	`QUARTZ_ACTIONUSER`
`static String`	`QUARTZ_AUTO_CREATE_UNIQUE_FILENAME`
`static String`	`QUARTZ_LINEAGE_ID`
`static String`	`QUARTZ_RESTART_FLAG`
`static String`	`QUARTZ_STREAMPROVIDER`
`static String`	`QUARTZ_STREAMPROVIDER_INPUT_FILE`
`static String`	`QUARTZ_UIPASSPARAM`
`static String`	`WORK_ITEM_UID`

Constructor Summary

Constructors
Constructor and Description

ActionUtil()

Constructors
Constructor and Description
`ActionUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static IAction`	`createActionBean(String actionClassName, String actionId)` Returns an instance of `IAction` created from the provided parameters.
`static String`	`extractUid(Map<String,Serializable> params)` Looks up the `ActionUtil.WORK_ITEM_UID` within the `Map`.
`static String`	`generateWorkItemUid(Map<String,Serializable> params)`
`static String`	`generateWorkItemUid(String inputFilePath, String userName)` Returns a unique id for a work item which includes the input file name (derived from `inputFilePath`), `user` and `date`, in the following format: WI-%input file name%-%user%-%date%, stripping any invalid characters.
`static void`	`prepareMap(Map<String,Serializable> params)` Prepares the `params` `Map` for action invocation, adding appropriate keys that are not scheduler specific, so that the action invocation code can operate on these mapped non-scheduler specific keys, rather than any keys defined within the scheduler.
`static void`	`removeKeyFromMap(Map<String,?> params, String key)` Removes the provided `key` from the `params` `Map` , if it exists, as well as its "equivalent", as defined within the `KEY_MAP`.
`static void`	`sendEmail(Map<String,Object> actionParams, Map<String,Serializable> params, String filePath)` Sends an email with the file representing the provided `filePath` as an attachment.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - QUARTZ_ACTIONCLASS
```
public static final String QUARTZ_ACTIONCLASS
```
    See Also:
    
    Constant Field Values
  - QUARTZ_ACTIONUSER
```
public static final String QUARTZ_ACTIONUSER
```
    See Also:
    
    Constant Field Values
  - QUARTZ_ACTIONID
```
public static final String QUARTZ_ACTIONID
```
    See Also:
    
    Constant Field Values
  - QUARTZ_STREAMPROVIDER
```
public static final String QUARTZ_STREAMPROVIDER
```
    See Also:
    
    Constant Field Values
  - QUARTZ_STREAMPROVIDER_INPUT_FILE
```
public static final String QUARTZ_STREAMPROVIDER_INPUT_FILE
```
    See Also:
    
    Constant Field Values
  - QUARTZ_UIPASSPARAM
```
public static final String QUARTZ_UIPASSPARAM
```
    See Also:
    
    Constant Field Values
  - QUARTZ_LINEAGE_ID
```
public static final String QUARTZ_LINEAGE_ID
```
    See Also:
    
    Constant Field Values
  - QUARTZ_RESTART_FLAG
```
public static final String QUARTZ_RESTART_FLAG
```
    See Also:
    
    Constant Field Values
  - QUARTZ_AUTO_CREATE_UNIQUE_FILENAME
```
public static final String QUARTZ_AUTO_CREATE_UNIQUE_FILENAME
```
    See Also:
    
    Constant Field Values
  - INVOKER_ACTIONPARAMS
```
public static final String INVOKER_ACTIONPARAMS
```
    See Also:
    
    Constant Field Values
  - INVOKER_ACTIONCLASS
```
public static final String INVOKER_ACTIONCLASS
```
    See Also:
    
    Constant Field Values
  - INVOKER_ACTIONUSER
```
public static final String INVOKER_ACTIONUSER
```
    See Also:
    
    Constant Field Values
  - INVOKER_ACTIONID
```
public static final String INVOKER_ACTIONID
```
    See Also:
    
    Constant Field Values
  - INVOKER_STREAMPROVIDER
```
public static final String INVOKER_STREAMPROVIDER
```
    See Also:
    
    Constant Field Values
  - INVOKER_STREAMPROVIDER_INPUT_FILE
```
public static final String INVOKER_STREAMPROVIDER_INPUT_FILE
```
    See Also:
    
    Constant Field Values
  - INVOKER_STREAMPROVIDER_OUTPUT_FILE_PATTERN
```
public static final String INVOKER_STREAMPROVIDER_OUTPUT_FILE_PATTERN
```
    See Also:
    
    Constant Field Values
  - INVOKER_STREAMPROVIDER_UNIQUE_FILE_NAME
```
public static final String INVOKER_STREAMPROVIDER_UNIQUE_FILE_NAME
```
    See Also:
    
    Constant Field Values
  - INVOKER_UIPASSPARAM
```
public static final String INVOKER_UIPASSPARAM
```
    See Also:
    
    Constant Field Values
  - INVOKER_RESTART_FLAG
```
public static final String INVOKER_RESTART_FLAG
```
    See Also:
    
    Constant Field Values
  - INVOKER_SESSION
```
public static final String INVOKER_SESSION
```
    See Also:
    
    Constant Field Values
  - INVOKER_ASYNC_EXEC
```
public static final String INVOKER_ASYNC_EXEC
```
    See Also:
    
    Constant Field Values
  - INVOKER_DEFAULT_ASYNC_EXEC_VALUE
```
public static final String INVOKER_DEFAULT_ASYNC_EXEC_VALUE
```
    See Also:
    
    Constant Field Values
  - INVOKER_SYNC_VALUE
```
public static final String INVOKER_SYNC_VALUE
```
    See Also:
    
    Constant Field Values
  - WORK_ITEM_UID
```
public static final String WORK_ITEM_UID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ActionUtil
```
public ActionUtil()
```
- Method Detail
  - removeKeyFromMap
```
public static void removeKeyFromMap(Map<String,?> params,
                                    String key)
```
    Removes the provided key from the params Map , if it exists, as well as its "equivalent", as defined within the KEY_MAP. If the provided key is a key within the KEY_MAP, its "equivalent" is the value. If the provided key is a value within the KEY_MAP, its "equivalent" is the key.
    
    Example: Given a KEY_MAP that looks like this:
    - firstName=first.name
    - lastName=last.name
    - addr=address
    - person.age=age
    a call to removeKeyFromMap( map, "firstName") will attempt to remove the "firstName" and "first.name" keys from the provided map. Likewise, a call to removeKeyFromMap( map, "last.name") will attempt to remove the "last.name" and "lastName" keys from the provided map.
    Parameters:
    
    params - the Map from which keys are being removed
    
    key - the String key being removed from the map
  - prepareMap
```
public static void prepareMap(Map<String,Serializable> params)
```
    Prepares the params Map for action invocation, adding appropriate keys that are not scheduler specific, so that the action invocation code can operate on these mapped non-scheduler specific keys, rather than any keys defined within the scheduler. The corresponding entries that use the scheduler related keys are removed.
    
    Parameters:
    
    params - the Map or parameters needed to invoke the IAction
  - extractUid
```
public static String extractUid(Map<String,Serializable> params)
```
    Looks up the ActionUtil.WORK_ITEM_UID within the Map. If available, the value is returned, otherwise a new uid is generated and placed within the Map. This is done ONLY if the IWorkItemLifecycleEventPublisher bean is defined, if the bean is not defined, null is returned. It is the caller's responsibility to handle this case gracefully.
    
    Parameters:
    
    params - a Map that may contain the ActionUtil.WORK_ITEM_UID
    
    Returns:
    
    ActionUtil.WORK_ITEM_UID from the Map or a new uid, or null in the absence of the IWorkItemLifecycleEventPublisher bean
  - generateWorkItemUid
```
public static String generateWorkItemUid(Map<String,Serializable> params)
```
    Parameters:
    
    params - a Map containing action/work item related attributes, in particular inputFile and actionUser, which are both used for the purpose of generating the uid.
    
    Returns:
    
    a unique id for the work item
    
    See Also:
    
    #generateWorkItemUid(String, String)}
  - generateWorkItemUid
```
public static String generateWorkItemUid(String inputFilePath,
                                         String userName)
```
    Returns a unique id for a work item which includes the input file name (derived from inputFilePath), user and date, in the following format: WI-%input file name%-%user%-%date%, stripping any invalid characters.
    
    Parameters:
    
    inputFilePath - the path of the input file of the action being invoked - optional
    
    userName - the user executing the action
    
    Returns:
    
    a unique id for the work item
  - createActionBean
```
public static IAction createActionBean(String actionClassName,
                                       String actionId)
                                throws ActionInvocationException
```
    Returns an instance of IAction created from the provided parameters.
    
    Parameters:
    
    actionClassName - the name of the class being resolved
    
    actionId - the is of the action which corresponds to some bean id
    
    Returns:
    
    IAction created from the provided parameters.
    
    Throws:
    
    Exception - when the IAction cannot be created for some reason
    
    ActionInvocationException
  - sendEmail
```
public static void sendEmail(Map<String,Object> actionParams,
                             Map<String,Serializable> params,
                             String filePath)
```
    Sends an email with the file representing the provided filePath as an attachment. All information needed to send the email (to, from, cc, bcc etc) is expected to be proviced in the actionParams Map.
    
    Parameters:
    
    actionParams - a Map of parameters needed to send the email
    
    params - a Map of parameter used to invoke the action
    
    filePath - the path of the repository file that was generated when the action was invoked

Class ActionUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

QUARTZ_ACTIONCLASS

QUARTZ_ACTIONUSER

QUARTZ_ACTIONID

QUARTZ_STREAMPROVIDER

QUARTZ_STREAMPROVIDER_INPUT_FILE

QUARTZ_UIPASSPARAM

QUARTZ_LINEAGE_ID

QUARTZ_RESTART_FLAG

QUARTZ_AUTO_CREATE_UNIQUE_FILENAME

INVOKER_ACTIONPARAMS

INVOKER_ACTIONCLASS

INVOKER_ACTIONUSER

INVOKER_ACTIONID

INVOKER_STREAMPROVIDER

INVOKER_STREAMPROVIDER_INPUT_FILE

INVOKER_STREAMPROVIDER_OUTPUT_FILE_PATTERN

INVOKER_STREAMPROVIDER_UNIQUE_FILE_NAME

INVOKER_UIPASSPARAM

INVOKER_RESTART_FLAG

INVOKER_SESSION

INVOKER_ASYNC_EXEC

INVOKER_DEFAULT_ASYNC_EXEC_VALUE

INVOKER_SYNC_VALUE

WORK_ITEM_UID

Constructor Detail

ActionUtil

Method Detail

removeKeyFromMap

prepareMap

extractUid

generateWorkItemUid

generateWorkItemUid

createActionBean

sendEmail