Package com.aspectran.core.activity
Class CoreTranslet
- java.lang.Object
-
- com.aspectran.core.activity.AbstractTranslet
-
- com.aspectran.core.activity.CoreTranslet
-
- All Implemented Interfaces:
Translet
public class CoreTranslet extends AbstractTranslet
The Class CoreTranslet.This class is generally not thread-safe. It is primarily designed for use in a single thread only.
-
-
Constructor Summary
Constructors Constructor Description CoreTranslet(TransletRule transletRule, CoreActivity activity)Instantiates a new CoreTranslet.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanacceptsProfiles(java.lang.String... profiles)Return whether the given profile is active.booleancontainsBean(java.lang.Class<?> type)Return whether a bean with the specified object type is present.booleancontainsBean(java.lang.Class<?> type, java.lang.String id)booleancontainsBean(java.lang.String id)Return whether a bean with the specified id is present.voiddispatch(DispatchRule dispatchRule)Dispatch to other resources as the given rule.voiddispatch(java.lang.String name)Dispatch to other resources as the given name.voiddispatch(java.lang.String name, java.lang.String dispatcherName)Dispatch to other resources as the given name.voidextractParameters(java.util.Map<java.lang.String,java.lang.Object> targetParameters)Extracts all the parameters and fills in the specified map.voidforward(ForwardRule forwardRule)Forward according to a given rule.voidforward(java.lang.String transletName)Forward to the specified translet immediately.ActivityDataMapgetActivityDataMap()Returns an Activity Data Map containing the activity result data.<V> VgetAfterAdviceResult(java.lang.String aspectId)Gets the after advice result.java.util.Map<java.lang.String,java.lang.Object>getAllParameters()Return an mutable Map of the request parameters, with parameter names as map keys and parameter values as map values.ApplicationAdaptergetApplicationAdapter()Gets the application adapter.<V> VgetAroundAdviceResult(java.lang.String aspectId)Gets the around advice result.<V> VgetAspectAdviceBean(java.lang.String aspectId)Gets the aspect advice bean.<V> VgetAttribute(java.lang.String name)Returns the value of the named attribute as a given type, ornullif no attribute of the given name exists.java.util.Collection<java.lang.String>getAttributeNames()Returns aCollectioncontaining the names of the attributes available to this request.<V> VgetBean(java.lang.Class<V> type)Return an instance of the bean that matches the given object type.<V> VgetBean(java.lang.Class<V> type, java.lang.String id)Return an instance of the bean that matches the given object type.<V> VgetBean(java.lang.String id)Return an instance of the bean that matches the given id.<V> VgetBeforeAdviceResult(java.lang.String aspectId)Gets the before advice result.ResponsegetDeclaredResponse()Returns the originally declared response.java.lang.StringgetDescription()Returns a description of thisTranslet.EnvironmentgetEnvironment()Returns the environment of the current activity context.FileParametergetFileParameter(java.lang.String name)Returns aFileParameterobject as a given activity's request parameter name, ornullif the parameter does not exist.java.util.Collection<java.lang.String>getFileParameterNames()Returns aCollectionofStringobjects containing the names of the file parameters contained in this request.FileParameter[]getFileParameterValues(java.lang.String name)Returns an array ofFileParameterobjects containing all of the values the given activity's request parameter has, ornullif the parameter does not exist.<V> VgetFinallyAdviceResult(java.lang.String aspectId)Gets the finally advice result.java.lang.StringgetIntendedRequestEncoding()Returns the intended request encoding.java.lang.StringgetIntendedResponseEncoding()Returns the intended response encoding.java.lang.StringgetMessage(java.lang.String code, java.lang.Object[] args)Try to resolve the message.java.lang.StringgetMessage(java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage)Try to resolve the message.java.lang.StringgetMessage(java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage, java.util.Locale locale)Try to resolve the message.java.lang.StringgetMessage(java.lang.String code, java.lang.Object[] args, java.util.Locale locale)Try to resolve the message.java.lang.StringgetParameter(java.lang.String name)Returns the value of an activity's request parameter as aString, ornullif the parameter does not exist.java.util.Collection<java.lang.String>getParameterNames()Returns aCollectionofStringobjects containing the names of the parameters contained in this request.java.lang.String[]getParameterValues(java.lang.String name)Returns an array ofStringobjects containing all of the values the given activity's request parameter has, ornullif the parameter does not exist.ProcessResultgetProcessResult()Returns the process result.java.lang.ObjectgetProcessResult(java.lang.String actionId)Returns a action result for the specified action id from the process result, ornullif the action does not exist.<V> VgetProperty(java.lang.String name)Returns the value of the property on environment.java.lang.ThrowablegetRaisedException()Returns the raised exception instance.<V> VgetRequestAdaptee()Returns the adaptee object to provide request information.RequestAdaptergetRequestAdapter()Gets the request adapter.<V> VgetResponseAdaptee()Returns the adaptee object to provide response information.ResponseAdaptergetResponseAdapter()Gets the response adapter.java.lang.ThrowablegetRootCauseOfRaisedException()Returns the innermost one of the chained (wrapped) exceptions.<V> VgetSessionAdaptee()Returns the adaptee object to provide session information.SessionAdaptergetSessionAdapter()Gets the session adapter.<V> VgetSetting(java.lang.String settingName)Gets the setting value in the translet scope.booleanhasPathVariables()Returns whether the translet name has tokens for extracting parameters or attributes.booleanisExceptionRaised()Returns whether the exception was thrown.voidredirect(RedirectRule redirectRule)Redirect a client according to the given rule.voidredirect(java.lang.String path)Redirect a client to a new target resource.voidredirect(java.lang.String path, java.util.Map<java.lang.String,java.lang.String> parameters)Redirect to the other target resource.voidremoveAttribute(java.lang.String name)Removes an attribute from this request.voidremoveFileParameter(java.lang.String name)Removes the file parameter with the specified name.voidremoveRaisedException()Remove the raised exception.voidresponse()Respond immediately, and the remaining jobs will be canceled.voidresponse(Response response)Respond immediately, and the remaining jobs will be canceled.voidsetAttribute(java.lang.String name, java.lang.Object value)Stores an attribute in this request.voidsetFileParameter(java.lang.String name, FileParameter fileParameter)Sets theFileParameterobject to the file parameter with the given name.voidsetFileParameter(java.lang.String name, FileParameter[] fileParameters)Sets the value to the file parameter with the given name.voidsetParameter(java.lang.String name, java.lang.String value)Sets the value to the parameter with the given name.voidsetParameter(java.lang.String name, java.lang.String[] values)Sets the value to the parameter with the given name.voidsetProcessResult(ProcessResult processResult)Sets the process result.java.lang.StringtoString()voidtransform(CustomTransformer transformer)voidtransform(TransformRule transformRule)Transformation according to a given rule, and transmits this response.-
Methods inherited from class com.aspectran.core.activity.AbstractTranslet
getParentTranslet, getRequestMethod, getRequestName, getRequestRule, getResponseRule, getTransletRule, hasParentTranslet, setParentTranslet, setRequestMethod, setRequestName
-
-
-
-
Constructor Detail
-
CoreTranslet
public CoreTranslet(TransletRule transletRule, CoreActivity activity)
Instantiates a new CoreTranslet.- Parameters:
transletRule- the translet ruleactivity- the current Activity
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Description copied from interface:TransletReturns a description of thisTranslet.- Returns:
- a description of this
Translet
-
getEnvironment
public Environment getEnvironment()
Description copied from interface:TransletReturns the environment of the current activity context.- Returns:
- the environment
-
getApplicationAdapter
public ApplicationAdapter getApplicationAdapter()
Description copied from interface:TransletGets the application adapter.- Returns:
- the application adapter
-
getSessionAdapter
public SessionAdapter getSessionAdapter()
Description copied from interface:TransletGets the session adapter.- Returns:
- the session adapter
-
getRequestAdapter
public RequestAdapter getRequestAdapter()
Description copied from interface:TransletGets the request adapter.- Returns:
- the request adapter
-
getResponseAdapter
public ResponseAdapter getResponseAdapter()
Description copied from interface:TransletGets the response adapter.- Returns:
- the response adapter
-
getSessionAdaptee
public <V> V getSessionAdaptee()
Description copied from interface:TransletReturns the adaptee object to provide session information.- Type Parameters:
V- the type of the session adaptee- Returns:
- the session adaptee object
-
getRequestAdaptee
public <V> V getRequestAdaptee()
Description copied from interface:TransletReturns the adaptee object to provide request information.- Type Parameters:
V- the type of the request adaptee- Returns:
- the request adaptee object
-
getResponseAdaptee
public <V> V getResponseAdaptee()
Description copied from interface:TransletReturns the adaptee object to provide response information.- Type Parameters:
V- the type of the response adaptee- Returns:
- the response adaptee object
-
getIntendedRequestEncoding
public java.lang.String getIntendedRequestEncoding()
Description copied from interface:TransletReturns the intended request encoding.- Returns:
- the intended request encoding
-
getIntendedResponseEncoding
public java.lang.String getIntendedResponseEncoding()
Description copied from interface:TransletReturns the intended response encoding.- Returns:
- the intended response encoding
-
getProcessResult
public ProcessResult getProcessResult()
Description copied from interface:TransletReturns the process result.- Returns:
- the process result
-
getProcessResult
public java.lang.Object getProcessResult(java.lang.String actionId)
Description copied from interface:TransletReturns a action result for the specified action id from the process result, ornullif the action does not exist.- Parameters:
actionId- the specified action id- Returns:
- the action result
-
setProcessResult
public void setProcessResult(ProcessResult processResult)
Description copied from interface:TransletSets the process result.- Parameters:
processResult- the new process result
-
getActivityDataMap
public ActivityDataMap getActivityDataMap()
Description copied from interface:TransletReturns an Activity Data Map containing the activity result data.- Returns:
- the activity data map
-
getSetting
public <V> V getSetting(java.lang.String settingName)
Description copied from interface:TransletGets the setting value in the translet scope.- Type Parameters:
V- the type of the value- Parameters:
settingName- the setting name- Returns:
- the setting value
-
getProperty
public <V> V getProperty(java.lang.String name)
Description copied from interface:TransletReturns the value of the property on environment.- Type Parameters:
V- the type of the value- Parameters:
name- the given property name- Returns:
- the value of the property on environment
-
getParameter
public java.lang.String getParameter(java.lang.String name)
Description copied from interface:TransletReturns the value of an activity's request parameter as aString, ornullif the parameter does not exist.- Parameters:
name- aStringspecifying the name of the parameter- Returns:
- a
Stringrepresenting the single value of the parameter - See Also:
Translet.getParameterValues(java.lang.String)
-
getParameterValues
public java.lang.String[] getParameterValues(java.lang.String name)
Description copied from interface:TransletReturns an array ofStringobjects containing all of the values the given activity's request parameter has, ornullif the parameter does not exist.- Parameters:
name- aStringspecifying the name of the parameter- Returns:
- an array of
Stringobjects containing the parameter's values - See Also:
Translet.getParameter(java.lang.String)
-
getParameterNames
public java.util.Collection<java.lang.String> getParameterNames()
Description copied from interface:TransletReturns aCollectionofStringobjects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an emptyCollection.- Returns:
- an
CollectionofStringobjects, eachStringcontaining the name of a request parameter; or an emptyCollectionif the request has no parameters
-
setParameter
public void setParameter(java.lang.String name, java.lang.String value)Description copied from interface:TransletSets the value to the parameter with the given name.- Parameters:
name- aStringspecifying the name of the parametervalue- aStringrepresenting the single value of the parameter- See Also:
Translet.setParameter(String, String[])
-
setParameter
public void setParameter(java.lang.String name, java.lang.String[] values)Description copied from interface:TransletSets the value to the parameter with the given name.- Parameters:
name- aStringspecifying the name of the parametervalues- an array ofStringobjects containing the parameter's values- See Also:
Translet.setParameter(java.lang.String, java.lang.String)
-
getAllParameters
public java.util.Map<java.lang.String,java.lang.Object> getAllParameters()
Description copied from interface:TransletReturn an mutable Map of the request parameters, with parameter names as map keys and parameter values as map values. If the parameter value type is theStringthen map value will be of typeString. If the parameter value type is theStringarray then map value will be of typeStringarray.- Returns:
- the mutable parameter map
-
extractParameters
public void extractParameters(java.util.Map<java.lang.String,java.lang.Object> targetParameters)
Description copied from interface:TransletExtracts all the parameters and fills in the specified map.- Parameters:
targetParameters- the target parameter map to be filled
-
getFileParameter
public FileParameter getFileParameter(java.lang.String name)
Description copied from interface:TransletReturns aFileParameterobject as a given activity's request parameter name, ornullif the parameter does not exist.- Parameters:
name- aStringspecifying the name of the file parameter- Returns:
- a
FileParameterrepresenting the single value of the parameter - See Also:
Translet.getFileParameterValues(java.lang.String)
-
getFileParameterValues
public FileParameter[] getFileParameterValues(java.lang.String name)
Description copied from interface:TransletReturns an array ofFileParameterobjects containing all of the values the given activity's request parameter has, ornullif the parameter does not exist.- Parameters:
name- aStringspecifying the name of the file parameter- Returns:
- an array of
FileParameterobjects containing the parameter's values - See Also:
Translet.getFileParameter(java.lang.String)
-
getFileParameterNames
public java.util.Collection<java.lang.String> getFileParameterNames()
Description copied from interface:TransletReturns aCollectionofStringobjects containing the names of the file parameters contained in this request. If the request has no parameters, the method returns an emptyCollection.- Returns:
- an
CollectionofStringobjects, eachStringcontaining the name of a file parameter; or an emptyCollectionif the request has no file parameters
-
setFileParameter
public void setFileParameter(java.lang.String name, FileParameter fileParameter)Description copied from interface:TransletSets theFileParameterobject to the file parameter with the given name.- Parameters:
name- aStringspecifying the name of the file parameterfileParameter- aFileParameterrepresenting the single value of the parameter- See Also:
Translet.setFileParameter(String, FileParameter[])
-
setFileParameter
public void setFileParameter(java.lang.String name, FileParameter[] fileParameters)Description copied from interface:TransletSets the value to the file parameter with the given name.- Parameters:
name- aStringspecifying the name of the file parameterfileParameters- an array ofFileParameterobjects containing the file parameter's values- See Also:
Translet.setFileParameter(java.lang.String, com.aspectran.core.activity.request.FileParameter)
-
removeFileParameter
public void removeFileParameter(java.lang.String name)
Description copied from interface:TransletRemoves the file parameter with the specified name.- Parameters:
name- aStringspecifying the name of the file parameter
-
getAttribute
public <V> V getAttribute(java.lang.String name)
Description copied from interface:TransletReturns the value of the named attribute as a given type, ornullif no attribute of the given name exists.- Type Parameters:
V- the result type of the bean- Parameters:
name- aStringspecifying the name of the attribute- Returns:
- an
Objectcontaining the value of the attribute, ornullif the attribute does not exist
-
setAttribute
public void setAttribute(java.lang.String name, java.lang.Object value)Description copied from interface:TransletStores an attribute in this request.- Parameters:
name- specifying the name of the attributevalue- theObjectto be stored
-
getAttributeNames
public java.util.Collection<java.lang.String> getAttributeNames()
Description copied from interface:TransletReturns aCollectioncontaining the names of the attributes available to this request. This method returns an emptyCollectionif the request has no attributes available to it.- Returns:
- the attribute names
-
removeAttribute
public void removeAttribute(java.lang.String name)
Description copied from interface:TransletRemoves an attribute from this request.- Parameters:
name- aStringspecifying the name of the attribute to remove
-
getDeclaredResponse
public Response getDeclaredResponse()
Description copied from interface:TransletReturns the originally declared response.- Returns:
- the declared response
-
response
public void response()
Description copied from interface:TransletRespond immediately, and the remaining jobs will be canceled.
-
response
public void response(Response response)
Description copied from interface:TransletRespond immediately, and the remaining jobs will be canceled.- Parameters:
response- the response
-
transform
public void transform(TransformRule transformRule)
Description copied from interface:TransletTransformation according to a given rule, and transmits this response.- Parameters:
transformRule- the transformation rule
-
transform
public void transform(CustomTransformer transformer)
-
dispatch
public void dispatch(java.lang.String name)
Description copied from interface:TransletDispatch to other resources as the given name.- Parameters:
name- the dispatch name
-
dispatch
public void dispatch(java.lang.String name, java.lang.String dispatcherName)Description copied from interface:TransletDispatch to other resources as the given name.- Parameters:
name- the dispatch namedispatcherName- the id or class name of the view dispatcher bean
-
dispatch
public void dispatch(DispatchRule dispatchRule)
Description copied from interface:TransletDispatch to other resources as the given rule.- Parameters:
dispatchRule- the dispatch rule
-
forward
public void forward(java.lang.String transletName)
Description copied from interface:TransletForward to the specified translet immediately.- Parameters:
transletName- the translet name of the target to be forwarded
-
forward
public void forward(ForwardRule forwardRule)
Description copied from interface:TransletForward according to a given rule.- Parameters:
forwardRule- the forward rule
-
redirect
public void redirect(java.lang.String path)
Description copied from interface:TransletRedirect a client to a new target resource. If an intended redirect rule exists, that may be used.- Parameters:
path- the redirect path
-
redirect
public void redirect(java.lang.String path, java.util.Map<java.lang.String,java.lang.String> parameters)Description copied from interface:TransletRedirect to the other target resource.- Parameters:
path- the redirect pathparameters- the parameters
-
redirect
public void redirect(RedirectRule redirectRule)
Description copied from interface:TransletRedirect a client according to the given rule.- Parameters:
redirectRule- the redirect rule
-
isExceptionRaised
public boolean isExceptionRaised()
Description copied from interface:TransletReturns whether the exception was thrown.- Returns:
- true, if is exception raised
-
getRaisedException
public java.lang.Throwable getRaisedException()
Description copied from interface:TransletReturns the raised exception instance.- Returns:
- the raised exception instance
-
removeRaisedException
public void removeRaisedException()
Description copied from interface:TransletRemove the raised exception.
-
getRootCauseOfRaisedException
public java.lang.Throwable getRootCauseOfRaisedException()
Description copied from interface:TransletReturns the innermost one of the chained (wrapped) exceptions.- Returns:
- the innermost one of the chained (wrapped) exceptions
-
acceptsProfiles
public boolean acceptsProfiles(java.lang.String... profiles)
Description copied from interface:TransletReturn whether the given profile is active. If active profiles are empty whether the profile should be active by default.- Parameters:
profiles- the profiles- Returns:
trueif profile is active, otherwisefalse
-
getAspectAdviceBean
public <V> V getAspectAdviceBean(java.lang.String aspectId)
Description copied from interface:TransletGets the aspect advice bean.- Type Parameters:
V- the result type of the advice- Parameters:
aspectId- the aspect id- Returns:
- the aspect advice bean
-
getBeforeAdviceResult
public <V> V getBeforeAdviceResult(java.lang.String aspectId)
Description copied from interface:TransletGets the before advice result.- Type Parameters:
V- the result type of the before advice- Parameters:
aspectId- the aspect id- Returns:
- the before advice result
-
getAfterAdviceResult
public <V> V getAfterAdviceResult(java.lang.String aspectId)
Description copied from interface:TransletGets the after advice result.- Type Parameters:
V- the result type of the after advice- Parameters:
aspectId- the aspect id- Returns:
- the after advice result
-
getAroundAdviceResult
public <V> V getAroundAdviceResult(java.lang.String aspectId)
Description copied from interface:TransletGets the around advice result.- Type Parameters:
V- the result type of the around advice- Parameters:
aspectId- the aspect id- Returns:
- the around advice result
-
getFinallyAdviceResult
public <V> V getFinallyAdviceResult(java.lang.String aspectId)
Description copied from interface:TransletGets the finally advice result.- Type Parameters:
V- the result type of the finally advice- Parameters:
aspectId- the aspect id- Returns:
- the finally advice result
-
hasPathVariables
public boolean hasPathVariables()
Description copied from interface:TransletReturns whether the translet name has tokens for extracting parameters or attributes.- Returns:
- true if the translet name has tokens for extracting parameters or attributes
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
getBean
public <V> V getBean(java.lang.String id)
Description copied from interface:TransletReturn an instance of the bean that matches the given id.- Type Parameters:
V- the result type of the bean- Parameters:
id- the id of the bean to retrieve- Returns:
- an instance of the bean
-
getBean
public <V> V getBean(java.lang.Class<V> type)
Description copied from interface:TransletReturn an instance of the bean that matches the given object type.- Type Parameters:
V- the result type of the bean- Parameters:
type- the type the bean must match; can be an interface or superclass.nullis disallowed.- Returns:
- an instance of the bean
-
getBean
public <V> V getBean(java.lang.Class<V> type, java.lang.String id)Description copied from interface:TransletReturn an instance of the bean that matches the given object type.- Type Parameters:
V- the result type of the bean- Parameters:
type- type the bean must match; can be an interface or superclass.nullis allowed.id- the id of the bean to retrieve- Returns:
- an instance of the bean
-
containsBean
public boolean containsBean(java.lang.String id)
Description copied from interface:TransletReturn whether a bean with the specified id is present.- Parameters:
id- the id of the bean to query- Returns:
- whether a bean with the specified id is present
-
containsBean
public boolean containsBean(java.lang.Class<?> type)
Description copied from interface:TransletReturn whether a bean with the specified object type is present.- Parameters:
type- the object type of the bean to query- Returns:
- whether a bean with the specified type is present
-
containsBean
public boolean containsBean(java.lang.Class<?> type, java.lang.String id)
-
getMessage
public java.lang.String getMessage(java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage, java.util.Locale locale)Description copied from interface:TransletTry to resolve the message. Return default message if no message was found.- Parameters:
code- the code to lookup up, such as 'calculator.noRateSet'. Users of this class are encouraged to base message names on the relevant fully qualified class name, thus avoiding conflict and ensuring maximum clarity.args- array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}" within a message), ornullif none.defaultMessage- String to return if the lookup failslocale- the Locale in which to do the lookup- Returns:
- the resolved message if the lookup was successful; otherwise the default message passed as a parameter
- See Also:
MessageFormat
-
getMessage
public java.lang.String getMessage(java.lang.String code, java.lang.Object[] args, java.util.Locale locale) throws NoSuchMessageExceptionDescription copied from interface:TransletTry to resolve the message. Treat as an error if the message can't be found.- Parameters:
code- the code to lookup up, such as 'calculator.noRateSet'args- Array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}" within a message), ornullif none.locale- the Locale in which to do the lookup- Returns:
- the resolved message
- Throws:
NoSuchMessageException- if the message wasn't found- See Also:
MessageFormat
-
getMessage
public java.lang.String getMessage(java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage)Description copied from interface:TransletTry to resolve the message. Return default message if no message was found.- Parameters:
code- the code to lookup up, such as 'calculator.noRateSet'. Users of this class are encouraged to base message names on the relevant fully qualified class name, thus avoiding conflict and ensuring maximum clarity.args- array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}" within a message), ornullif none.defaultMessage- String to return if the lookup fails- Returns:
- the resolved message if the lookup was successful; otherwise the default message passed as a parameter
- See Also:
MessageFormat
-
getMessage
public java.lang.String getMessage(java.lang.String code, java.lang.Object[] args) throws NoSuchMessageExceptionDescription copied from interface:TransletTry to resolve the message. Treat as an error if the message can't be found.- Parameters:
code- the code to lookup up, such as 'calculator.noRateSet'args- Array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}" within a message), ornullif none.- Returns:
- the resolved message
- Throws:
NoSuchMessageException- if the message wasn't found- See Also:
MessageFormat
-
-