ActionContext (Atlassian Vendor Patch of Webwork 1 1.4-atlassian-30 API)

java.lang.Object
- webwork.action.ActionContext

```
public class ActionContext
extends Object
```
Handles the context of each invoked action while providing an abstraction layer for both servlet and non servlet based applications.
Information is associated with the action's thread so it can be accessed from anywhere by calling a static method.
The context is initially set by the dispatcher.

Version:

$Revision: 1.14 $

Author:

Rickard Öberg (rickard@middleware-company.com), Matt Baldree (matt@smallleap.com), Maurice C. Parker (maurice@vineyardenterprise.com)

See Also:
ServletDispatcher, ClientServletDispatcher

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_NAME`
`static String`	`APPLICATION`
`static String`	`LOCALE`
`static String`	`PARAMETERS`
`static String`	`PRINCIPAL`
`static String`	`SESSION`
`static String`	`SINGLE_VALUE_PARAMETERS`

Constructor Summary

Constructors
Constructor and Description

ActionContext()

Constructors
Constructor and Description
`ActionContext()`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`get(Object key)` Returns a value that is stored in the current ActionContext buy doing a lookup using the value's key.
`static Map`	`getApplication()` Returns a Map of the ServletContext when in a servlet environment or a generic application level Map otherwise.
`Map`	`getApplicationImpl()`
`static ActionContext`	`getContext()` Returns the ActionContext specific to the current thread.
`static Locale`	`getLocale()` Returns the Locale of the current request in a servlet environment or the default Locale in other environments.
`Locale`	`getLocaleImpl()`
`static MultiPartRequestWrapper`	`getMultiPartRequest()` Return multipart request for HttpServletRequest.
`MultiPartRequestWrapper`	`getMultiPartRequestImpl()`
`static String`	`getName()` Returns the name of the current Action.
`String`	`getNameImpl()`
`static Map`	`getParameters()` Returns a Map of the HttpServletRequest parameters when in a servlet environment or a generic Map of parameters otherwise.
`Map`	`getParametersImpl()`
`static Principal`	`getPrincipal()` Returns the current user's security Principal.
`Principal`	`getPrincipalImpl()`
`static javax.servlet.http.HttpServletRequest`	`getRequest()` Returns the HttpServletRequest object when in a servlet environment.
`javax.servlet.http.HttpServletRequest`	`getRequestImpl()`
`static javax.servlet.http.HttpServletResponse`	`getResponse()` Returns the HttpServletResponse when in a servlet environment.
`javax.servlet.http.HttpServletResponse`	`getResponseImpl()`
`static javax.servlet.ServletContext`	`getServletContext()` Returns the ServletContext when in a servlet environment.
`javax.servlet.ServletContext`	`getServletContextImpl()`
`static Map`	`getSession()` Returns the HttpSession when in a servlet environment or a generic session map otherwise.
`Map`	`getSessionImpl()`
`static Map`	`getSingleValueParameters()` Get the current ActionContext parameters.
`Map`	`getSingleValueParametersImpl()`
`Map`	`getTable()`
`static ValueStack`	`getValueStack()` Returns the ValueStack specific to the current thread.
`ValueStack`	`getValueStackImpl()`
`void`	`put(Object key, Object value)` Stores a value in the current ActionContext.
`static void`	`setApplication(Map application)` Set an application level Map.
`void`	`setApplicationImpl(Map application)`
`static void`	`setContext(ActionContext aContext)`
`static void`	`setLocale(Locale locale)` Set the current locale.
`void`	`setLocaleImpl(Locale locale)`
`static void`	`setName(String name)` Stores the name of the current Action in the ActionContext.
`void`	`setNameImpl(String name)`
`static void`	`setParameters(Map parameters)` Set a Map of parameters.
`void`	`setParametersImpl(Map parameters)`
`static void`	`setPrincipal(Principal principal)` Set the current user's security Principal.
`void`	`setPrincipalImpl(Principal principal)`
`static void`	`setRequest(javax.servlet.http.HttpServletRequest request)` Set the HttpServletRequest.
`void`	`setRequestImpl(javax.servlet.http.HttpServletRequest request)`
`static void`	`setResponse(javax.servlet.http.HttpServletResponse response)` Set the HttpServletResponse.
`void`	`setResponseImpl(javax.servlet.http.HttpServletResponse response)`
`static void`	`setServletContext(javax.servlet.ServletContext context)` Set the ServletContext.
`void`	`setServletContextImpl(javax.servlet.ServletContext context)`
`static void`	`setSession(Map session)` Set a session Map.
`void`	`setSessionImpl(Map session)`
`static void`	`setSingleValueParameters(Map parameters)` Set a Map of single value parameters.
`void`	`setSingleValueParametersImpl(Map parameters)`
`void`	`setTable(Map lookup)`
`static void`	`setValueStack(ValueStack valueStack)` Set the ValueStack.
`void`	`setValueStackImpl(ValueStack valueStack)`

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

- Field Detail
  - ACTION_NAME
```
public static final String ACTION_NAME
```
    See Also:
    Constant Field Values
  - SESSION
```
public static final String SESSION
```
    See Also:
    Constant Field Values
  - APPLICATION
```
public static final String APPLICATION
```
    See Also:
    Constant Field Values
  - PARAMETERS
```
public static final String PARAMETERS
```
    See Also:
    Constant Field Values
  - SINGLE_VALUE_PARAMETERS
```
public static final String SINGLE_VALUE_PARAMETERS
```
    See Also:
    Constant Field Values
  - LOCALE
```
public static final String LOCALE
```
    See Also:
    Constant Field Values
  - PRINCIPAL
```
public static final String PRINCIPAL
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ActionContext
```
public ActionContext()
```
- Method Detail
  - setContext
```
public static void setContext(ActionContext aContext)
```
  - getContext
```
public static ActionContext getContext()
```
    Returns the ActionContext specific to the current thread.
    
    Returns:
    ActionContext for the current thread
  - getTable
```
public Map getTable()
```
  - setTable
```
public void setTable(Map lookup)
```
  - put
```
public void put(Object key,
       Object value)
```
    Stores a value in the current ActionContext. The value can be looked up using the key.
    
    Parameters:
    key - The key of the value.
    value - The value to be stored.
  - get
```
public Object get(Object key)
```
    Returns a value that is stored in the current ActionContext buy doing a lookup using the value's key.
    
    Parameters:
    key - The key used to find the value.
    
    Returns:
    The value that was found using the key.
  - getName
```
public static String getName()
```
    Returns the name of the current Action.
    
    Returns:
    The current Action name.
  - getNameImpl
```
public String getNameImpl()
```
  - setName
```
public static void setName(String name)
```
    Stores the name of the current Action in the ActionContext.
    
    Parameters:
    name - The name of the current action.
  - setNameImpl
```
public void setNameImpl(String name)
```
  - getLocale
```
public static Locale getLocale()
```
    Returns the Locale of the current request in a servlet environment or the default Locale in other environments.
    
    Returns:
    current locale
  - getLocaleImpl
```
public Locale getLocaleImpl()
```
  - setLocale
```
public static void setLocale(Locale locale)
```
    Set the current locale.
    
    Parameters:
    locale - current locale
  - setLocaleImpl
```
public void setLocaleImpl(Locale locale)
```
  - getSession
```
public static Map getSession()
```
    Returns the HttpSession when in a servlet environment or a generic session map otherwise.
    
    Returns:
    a map of HttpSession or a generic session map
  - getSessionImpl
```
public Map getSessionImpl()
```
  - setSession
```
public static void setSession(Map session)
```
    Set a session Map.
  - setSessionImpl
```
public void setSessionImpl(Map session)
```
  - getApplication
```
public static Map getApplication()
```
    Returns a Map of the ServletContext when in a servlet environment or a generic application level Map otherwise.
    
    Returns:
    Map of ServletContext or generic application level Map
  - getApplicationImpl
```
public Map getApplicationImpl()
```
  - setApplication
```
public static void setApplication(Map application)
```
    Set an application level Map.
  - setApplicationImpl
```
public void setApplicationImpl(Map application)
```
  - getParameters
```
public static Map getParameters()
```
    Returns a Map of the HttpServletRequest parameters when in a servlet environment or a generic Map of parameters otherwise.
    
    Returns:
    Map of HttpServletRequest parameters, generic Map of parameters, or multipart Map.
  - getParametersImpl
```
public Map getParametersImpl()
```
  - setParameters
```
public static void setParameters(Map parameters)
```
    Set a Map of parameters.
    
    Parameters:
    parameters - The parameters for the current action context.
  - setParametersImpl
```
public void setParametersImpl(Map parameters)
```
  - getSingleValueParameters
```
public static Map getSingleValueParameters()
```
    Get the current ActionContext parameters. Each Map entry is a String.
    
    Returns:
    The parameters for the current action context.
  - getSingleValueParametersImpl
```
public Map getSingleValueParametersImpl()
```
  - setSingleValueParameters
```
public static void setSingleValueParameters(Map parameters)
```
    Set a Map of single value parameters.
    
    Parameters:
    parameters - for the current action context.
  - setSingleValueParametersImpl
```
public void setSingleValueParametersImpl(Map parameters)
```
  - getPrincipal
```
public static Principal getPrincipal()
```
    Returns the current user's security Principal.
    
    Returns:
    the current user's security Principal
  - getPrincipalImpl
```
public Principal getPrincipalImpl()
```
  - setPrincipal
```
public static void setPrincipal(Principal principal)
```
    Set the current user's security Principal.
    
    Parameters:
    principal - the current user's security Principal
  - setPrincipalImpl
```
public void setPrincipalImpl(Principal principal)
```
  - getMultiPartRequest
```
public static MultiPartRequestWrapper getMultiPartRequest()
```
    Return multipart request for HttpServletRequest.
    
    Returns:
    MultiPartRequestWrapper
  - getMultiPartRequestImpl
```
public MultiPartRequestWrapper getMultiPartRequestImpl()
```
  - getRequest
```
public static javax.servlet.http.HttpServletRequest getRequest()
```
    Returns the HttpServletRequest object when in a servlet environment.
    
    Returns:
    HttpServletRequest in a servlet environment or null otherwise
  - getRequestImpl
```
public javax.servlet.http.HttpServletRequest getRequestImpl()
```
  - setRequest
```
public static void setRequest(javax.servlet.http.HttpServletRequest request)
```
    Set the HttpServletRequest.
  - setRequestImpl
```
public void setRequestImpl(javax.servlet.http.HttpServletRequest request)
```
  - getResponse
```
public static javax.servlet.http.HttpServletResponse getResponse()
```
    Returns the HttpServletResponse when in a servlet environment.
    
    Returns:
    HttpServletResponse or null
  - getResponseImpl
```
public javax.servlet.http.HttpServletResponse getResponseImpl()
```
  - setResponse
```
public static void setResponse(javax.servlet.http.HttpServletResponse response)
```
    Set the HttpServletResponse.
  - setResponseImpl
```
public void setResponseImpl(javax.servlet.http.HttpServletResponse response)
```
  - getServletContext
```
public static javax.servlet.ServletContext getServletContext()
```
    Returns the ServletContext when in a servlet environment.
    
    Returns:
    ServletContext or null.
  - getServletContextImpl
```
public javax.servlet.ServletContext getServletContextImpl()
```
  - setServletContext
```
public static void setServletContext(javax.servlet.ServletContext context)
```
    Set the ServletContext.
  - setServletContextImpl
```
public void setServletContextImpl(javax.servlet.ServletContext context)
```
  - getValueStack
```
public static ValueStack getValueStack()
```
    Returns the ValueStack specific to the current thread.
    
    Returns:
    ActionContext for the current thread
  - getValueStackImpl
```
public ValueStack getValueStackImpl()
```
  - setValueStack
```
public static void setValueStack(ValueStack valueStack)
```
    Set the ValueStack.
    
    Parameters:
    valueStack -
  - setValueStackImpl
```
public void setValueStackImpl(ValueStack valueStack)
```

Class ActionContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTION_NAME

SESSION

APPLICATION

PARAMETERS

SINGLE_VALUE_PARAMETERS

LOCALE

PRINCIPAL

Constructor Detail

ActionContext

Method Detail

setContext

getContext

getTable

setTable

put

get

getName

getNameImpl

setName

setNameImpl

getLocale

getLocaleImpl

setLocale

setLocaleImpl

getSession

getSessionImpl

setSession

setSessionImpl

getApplication

getApplicationImpl

setApplication

setApplicationImpl

getParameters

getParametersImpl

setParameters

setParametersImpl

getSingleValueParameters

getSingleValueParametersImpl

setSingleValueParameters

setSingleValueParametersImpl

getPrincipal

getPrincipalImpl

setPrincipal

setPrincipalImpl

getMultiPartRequest

getMultiPartRequestImpl

getRequest

getRequestImpl

setRequest

setRequestImpl

getResponse

getResponseImpl

setResponse

setResponseImpl

getServletContext

getServletContextImpl

setServletContext

setServletContextImpl

getValueStack

getValueStackImpl

setValueStack

setValueStackImpl