public class LifecycleContext
extends java.util.HashMap
LifecycleContext
contains all the state information that will
be kept during the Lifecycle. It is passed as a method parameter to each
of the phases of the Lifecycle
.
Since it extends the HashMap class it can be use to append additional user
data.
This context object lives for the duration of the current lifecycle.
NOTE: Implementations of
Lifecycle
should be thread-safe
and use the LifecycleContext
object as the place
to store any per-request state they may need.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EVENT_METHOD_PREFIX
Deprecated.
Prefix used for each event method.
|
static java.lang.String |
EVENT_PREFIX
Deprecated.
The default value to be used by the lifecycle to reconize
an event in a parameter name.
|
Constructor and Description |
---|
LifecycleContext()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
addControlActionBinding(java.lang.String event,
oracle.jbo.uicli.binding.JUCtrlActionBinding actionBinding)
Deprecated.
This method add an action binding to the collection of action being
executed.
|
void |
addEvent(java.lang.String event)
Deprecated.
Add an event name to the list of event to be handled during this
lifecycle.
|
oracle.adf.model.binding.DCBindingContainer |
getBindingContainer()
Deprecated.
Retrieve the Model binding container from the context.
|
oracle.adf.model.BindingContext |
getBindingContext()
Deprecated.
Retrieve the BindingContext from the context.
|
java.util.Map |
getControlActionBindings()
Deprecated.
Retrieve a list of all action binding keyed by event name.
|
oracle.jbo.uicli.binding.JUCtrlActionBinding |
getCustomMethod()
Deprecated.
Retrieve the custom method Action binding from the context.
|
oracle.jbo.uicli.binding.JUCtrlActionBinding |
getEventActionBinding()
Deprecated.
Retrieve the ActionBinding associated with the current event.
|
java.lang.String |
getEventPrefix()
Deprecated.
Retrieve the event prefix from the context.
|
java.util.List |
getEvents()
Deprecated.
Retrieve the list of event names to be handled during this lifecycle.
|
java.lang.String |
getForwardPath()
Deprecated.
Retrieve the path of the page that the Lifecycle will forward to.
|
javax.servlet.http.HttpServletRequest |
getHttpServletRequest()
Deprecated.
Retrieve the HttpServletRequest from the context.
|
javax.servlet.http.HttpServletResponse |
getHttpServletResponse()
Deprecated.
Retrieve the HttpServletResponse from the context.
|
Lifecycle |
getLifecycle()
Deprecated.
Retrieve the Lifecycle from the context.
|
java.lang.String |
getModelReference()
Deprecated.
Retrieve the ModelReference name property from the context.
|
boolean |
getRedirect()
Deprecated.
Retrieve the redirect setting from the context.
|
void |
initialize(Lifecycle lifecycle,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Deprecated.
Initialize the context with the Lifecycle it is going to be use with and
the request and response information.
|
void |
initialize(Lifecycle lifecycle,
java.lang.String modelRef,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Deprecated.
Initialize the context with the name of the model reference to be use
during this Lifecycle.
|
void |
setBindingContainer(oracle.adf.model.binding.DCBindingContainer bindings)
Deprecated.
Store the Model binding container in the context.
|
void |
setBindingContext(oracle.adf.model.BindingContext bindingContext)
Deprecated.
Store the BindingContext in the context.
|
void |
setCustomMethod(oracle.jbo.uicli.binding.JUCtrlActionBinding actionBinding)
Deprecated.
Set the custom method Action binding in the context.
|
void |
setEventActionBinding(oracle.jbo.uicli.binding.JUCtrlActionBinding action)
Deprecated.
Set the ActionBinding for the current event.
|
void |
setEventPrefix(java.lang.String prefix)
Deprecated.
Set the prefix that will be used to reconize event request parameters.
|
void |
setForwardPath(java.lang.String path)
Deprecated.
Set the path of the page to which the Lifecycle should forward.
|
void |
setHttpServletRequest(javax.servlet.http.HttpServletRequest request)
Deprecated.
Store the HttpServletRequest in the context.
|
void |
setHttpServletResponse(javax.servlet.http.HttpServletResponse response)
Deprecated.
Store the HttpServletResponse in the context.
|
void |
setLifecycle(Lifecycle lifeCycle)
Deprecated.
Store a Lifecycle object in the context.
|
void |
setModelReference(java.lang.String modelRef)
Deprecated.
Store the Model Reference name in the context.
|
void |
setRedirect(boolean redirect)
Deprecated.
Specify if the page path information defined using the setForwardPath
should be use to forward the request or redirect the response.
|
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
public static final java.lang.String EVENT_PREFIX
public static final java.lang.String EVENT_METHOD_PREFIX
public void initialize(Lifecycle lifecycle, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
lifecycle
- the lifecyclerequest
- the current HttpServletRequestresponse
- the current HttpServletResponsepublic void initialize(Lifecycle lifecycle, java.lang.String modelRef, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
lifecycle
- The lifecycle object in use for the current request.modelRef
- The name of the UIModel to use for the binding containerrequest
- The current HTTP request objectresponse
- The current HTTP response objectpublic void setLifecycle(Lifecycle lifeCycle)
lifeCycle
- Lifecycle object to use for the current request.public Lifecycle getLifecycle()
public void setHttpServletRequest(javax.servlet.http.HttpServletRequest request)
request
- Current HTTP Request object.public javax.servlet.http.HttpServletRequest getHttpServletRequest()
public void setHttpServletResponse(javax.servlet.http.HttpServletResponse response)
response
- Current HTTP response object.public javax.servlet.http.HttpServletResponse getHttpServletResponse()
public void setBindingContext(oracle.adf.model.BindingContext bindingContext)
bindingContext
- BindingContext in use for the current request.public oracle.adf.model.BindingContext getBindingContext()
public void setModelReference(java.lang.String modelRef)
modelRef
- the model referencepublic java.lang.String getModelReference()
public void setBindingContainer(oracle.adf.model.binding.DCBindingContainer bindings)
bindings
- Binding container to use for the current request.public oracle.adf.model.binding.DCBindingContainer getBindingContainer()
public void setCustomMethod(oracle.jbo.uicli.binding.JUCtrlActionBinding actionBinding)
actionBinding
- Action binding object to call during current request.public oracle.jbo.uicli.binding.JUCtrlActionBinding getCustomMethod()
public void setEventActionBinding(oracle.jbo.uicli.binding.JUCtrlActionBinding action)
action
- Action binding to invoke as the event's default action.public oracle.jbo.uicli.binding.JUCtrlActionBinding getEventActionBinding()
Here is an example for an event named Commit:
public void onCommit(LifecycleContext ctx) { // write pre-execution logic here ctx.getEventActionBinding().doit(); // write post-execution logic here }
Return null is no ActionBinding is associated with this event.
public void setEventPrefix(java.lang.String prefix)
Set the prefix that will be used to reconize event request parameters. To change the default prefix "event", call this method with a different prefix every time the lifecycle context is initialized.
?event=xxx
name="event_xxx"
prefix
- the new prefix stringEVENT_PREFIX
public java.lang.String getEventPrefix()
EVENT_PREFIX
public void addControlActionBinding(java.lang.String event, oracle.jbo.uicli.binding.JUCtrlActionBinding actionBinding)
event
- an event nameactionBinding
- the action binding to be associated with the eventpublic java.util.Map getControlActionBindings()
public void addEvent(java.lang.String event)
event
- an event namepublic java.util.List getEvents()
PageLifecycle.buildEventList(LifecycleContext)
public void setForwardPath(java.lang.String path)
path
- Relative path of next page.PageLifecycle.findForward(LifecycleContext)
,
setRedirect(boolean)
public java.lang.String getForwardPath()
PageLifecycle.findForward(LifecycleContext)
public void setRedirect(boolean redirect)
redirect
- a booleansetForwardPath(java.lang.String)
,
PageLifecycle.findForward(LifecycleContext)
public boolean getRedirect()
setRedirect(boolean)