Package com.aspectran.core.activity

Interface Translet

All Known Implementing Classes:
AbstractTranslet, CoreTranslet
public interface Translet
Translet provides the parsed request data to the user and processes the user's response command.

Created: 2008. 7. 5. AM 12:35:44

  • Method Details

    • getContextPath

      String getContextPath()

    • getRelativeName

      String getRelativeName()

    • getRequestName

      String getRequestName()
      Returns the request name for this Translet.
      Returns:
      the request name

    • getRequestMethod

      MethodType getRequestMethod()
      Gets the request http method.
      Returns:
      the request method

    • getTransletName

      String getTransletName()
      Returns the translet name.
      Returns:
      the translet name

    • getDescription

      String getDescription()
      Returns a description of this Translet.
      Returns:
      a description of this Translet

    • getEnvironment

      Environment getEnvironment()
      Returns the environment of the current activity context.
      Returns:
      the environment

    • getApplicationAdapter

      ApplicationAdapter getApplicationAdapter()
      Gets the application adapter.
      Returns:
      the application adapter

    • getSessionAdapter

      SessionAdapter getSessionAdapter()
      Gets the session adapter.
      Returns:
      the session adapter

    • getRequestAdapter

      RequestAdapter getRequestAdapter()
      Gets the request adapter.
      Returns:
      the request adapter

    • getResponseAdapter

      ResponseAdapter getResponseAdapter()
      Gets the response adapter.
      Returns:
      the response adapter

    • getSessionAdaptee

      <V> V getSessionAdaptee()
      Returns the adaptee object to provide session information.
      Type Parameters:
      V - the type of the session adaptee
      Returns:
      the session adaptee object

    • getRequestAdaptee

      <V> V getRequestAdaptee()
      Returns the adaptee object to provide request information.
      Type Parameters:
      V - the type of the request adaptee
      Returns:
      the request adaptee object

    • getResponseAdaptee

      <V> V getResponseAdaptee()
      Returns the adaptee object to provide response information.
      Type Parameters:
      V - the type of the response adaptee
      Returns:
      the response adaptee object

    • getIntendedRequestEncoding

      String getIntendedRequestEncoding()
      Returns the intended request encoding.
      Returns:
      the intended request encoding

    • getIntendedResponseEncoding

      String getIntendedResponseEncoding()
      Returns the intended response encoding.
      Returns:
      the intended response encoding

    • getProcessResult

      ProcessResult getProcessResult()
      Returns the process result.
      Returns:
      the process result

    • getProcessResult

      Object getProcessResult(String actionId)
      Returns an action result for the specified action id from the process result, or null if the action does not exist.
      Parameters:
      actionId - the specified action id
      Returns:
      the action result

    • setProcessResult

      void setProcessResult(ProcessResult processResult)
      Sets the process result.
      Parameters:
      processResult - the new process result

    • getActivityData

      ActivityData getActivityData()
      Returns an Activity Data containing the activity result data.
      Returns:
      the activity data

    • getSetting

      <V> V getSetting(String settingName)
      Gets 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

      <V> V getProperty(String name)
      Returns 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

      String getParameter(String name)
      Returns the value of an activity's request parameter as a String, or null if the parameter does not exist.
      Parameters:
      name - a String specifying the name of the parameter
      Returns:
      a String representing the single value of the parameter
      See Also:

    • getParameterValues

      String[] getParameterValues(String name)
      Returns an array of String objects containing all the values the given activity's request parameter has, or null if the parameter does not exist.
      Parameters:
      name - a String specifying the name of the parameter
      Returns:
      an array of String objects containing the parameter's values
      See Also:

    • getParameterNames

      Collection<String> getParameterNames()
      Returns a Collection of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Collection.
      Returns:
      an Collection of String objects, each String containing the name of a request parameter; or an empty Collection if the request has no parameters

    • setParameter

      void setParameter(String name, String value)
      Sets the value to the parameter with the given name.
      Parameters:
      name - a String specifying the name of the parameter
      value - a String representing the single value of the parameter
      See Also:

    • setParameter

      void setParameter(String name, String[] values)
      Sets the value to the parameter with the given name.
      Parameters:
      name - a String specifying the name of the parameter
      values - an array of String objects containing the parameter's values
      See Also:

    • getAllParameters

      Map<String,Object> getAllParameters()
      Return a mutable Map of the request parameters, with parameter names as map keys and parameter values as map values. If the parameter value type is the String then map value will be of type String. If the parameter value type is the String array then map value will be of type String array.
      Returns:
      the mutable parameter map
      Since:
      1.4.0

    • extractParameters

      void extractParameters(Map<String,Object> targetParameters)
      Extracts all the parameters and fills in the specified map.
      Parameters:
      targetParameters - the target parameter map to be filled
      Since:
      2.0.0

    • getFileParameter

      FileParameter getFileParameter(String name)
      Returns a FileParameter object as a given activity's request parameter name, or null if the parameter does not exist.
      Parameters:
      name - a String specifying the name of the file parameter
      Returns:
      a FileParameter representing the single value of the parameter
      See Also:

    • getFileParameterValues

      FileParameter[] getFileParameterValues(String name)
      Returns an array of FileParameter objects containing all the values the given activity's request file parameter has, or null if the parameter does not exist.
      Parameters:
      name - a String specifying the name of the file parameter
      Returns:
      an array of FileParameter objects containing the parameter's values
      See Also:

    • getFileParameterNames

      Collection<String> getFileParameterNames()
      Returns a Collection of String objects containing the names of the file parameters contained in this request. If the request has no parameters, the method returns an empty Collection.
      Returns:
      an Collection of String objects, each String containing the name of a file parameter; or an empty Collection if the request has no file parameters

    • setFileParameter

      void setFileParameter(String name, FileParameter fileParameter)
      Sets the FileParameter object to the file parameter with the given name.
      Parameters:
      name - a String specifying the name of the file parameter
      fileParameter - a FileParameter representing the single value of the parameter
      See Also:

    • setFileParameter

      void setFileParameter(String name, FileParameter[] fileParameters)
      Sets the value to the file parameter with the given name.
      Parameters:
      name - a String specifying the name of the file parameter
      fileParameters - an array of FileParameter objects containing the file parameter's values
      See Also:

    • removeFileParameter

      void removeFileParameter(String name)
      Removes the file parameter with the specified name.
      Parameters:
      name - a String specifying the name of the file parameter

    • getAttribute

      <V> V getAttribute(String name)
      Returns the value of the named attribute as a given type, or null if no attribute of the given name exists.
      Type Parameters:
      V - the type of attribute retrieved
      Parameters:
      name - a String specifying the name of the attribute
      Returns:
      an Object containing the value of the attribute, or null if the attribute does not exist

    • setAttribute

      void setAttribute(String name, Object value)
      Stores an attribute in this request.
      Parameters:
      name - specifying the name of the attribute
      value - the Object to be stored

    • getAttributeNames

      Collection<String> getAttributeNames()
      Returns a Collection containing the names of the attributes available to this request. This method returns an empty Collection if the request has no attributes available to it.
      Returns:
      the attribute names

    • removeAttribute

      void removeAttribute(String name)
      Removes an attribute from this request.
      Parameters:
      name - a String specifying the name of the attribute to remove

    • transform

      void transform(TransformRule transformRule)
      Transformation according to a given rule, and transmits this response.
      Parameters:
      transformRule - the transformation rule

    • transform

      void transform(CustomTransformer transformer)

    • dispatch

      void dispatch(String name)
      Dispatch to other resources as the given name.
      Parameters:
      name - the dispatch name

    • dispatch

      void dispatch(String name, String dispatcherName)
      Dispatch to other resources as the given name.
      Parameters:
      name - the dispatch name
      dispatcherName - the id or class name of the view dispatcher bean

    • dispatch

      void dispatch(DispatchRule dispatchRule)
      Dispatch to other resources as the given rule.
      Parameters:
      dispatchRule - the dispatch rule

    • forward

      void forward(String transletName)
      Forward to the specified translet immediately.
      Parameters:
      transletName - the translet name of the target to be forwarded

    • forward

      void forward(ForwardRule forwardRule)
      Forward according to a given rule.
      Parameters:
      forwardRule - the forward rule

    • redirect

      void redirect(String path)
      Redirect a client to a new target resource. If an intended redirect rule exists, that may be used.
      Parameters:
      path - the redirect path

    • redirect

      void redirect(String path, Map<String,String> parameters)
      Redirect to the other target resource.
      Parameters:
      path - the redirect path
      parameters - the parameters

    • redirect

      void redirect(RedirectRule redirectRule)
      Redirect a client according to the given rule.
      Parameters:
      redirectRule - the redirect rule

    • response

      void response(Response response)
      Respond immediately, and the remaining jobs will be canceled.
      Parameters:
      response - the response

    • response

      void response()
      Respond immediately, and the remaining jobs will be canceled.

    • getDeclaredResponse

      Response getDeclaredResponse()
      Returns the originally declared response.
      Returns:
      the declared response
      Since:
      5.2.0

    • isResponseReserved

      boolean isResponseReserved()
      Returns whether the response is reserved.
      Returns:
      true, if the response is reserved

    • isExceptionRaised

      boolean isExceptionRaised()
      Returns whether the exception was thrown.
      Returns:
      true, if is exception raised

    • getRaisedException

      Throwable getRaisedException()
      Returns the raised exception instance.
      Returns:
      the raised exception instance

    • getRootCauseOfRaisedException

      Throwable getRootCauseOfRaisedException()
      Returns the innermost one of the chained (wrapped) exceptions.
      Returns:
      the innermost one of the chained (wrapped) exceptions

    • removeRaisedException

      void removeRaisedException()
      Remove the raised exception.

    • getAspectAdviceBean

      <V> V getAspectAdviceBean(String aspectId)
      Gets the aspect advice bean.
      Type Parameters:
      V - the result type of the advice
      Parameters:
      aspectId - the aspect id
      Returns:
      the aspect advice bean

    • getBeforeAdviceResult

      <V> V getBeforeAdviceResult(String aspectId)
      Gets 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

      <V> V getAfterAdviceResult(String aspectId)
      Gets 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

      <V> V getAroundAdviceResult(String aspectId)
      Gets 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

      <V> V getFinallyAdviceResult(String aspectId)
      Gets the final advice result.
      Type Parameters:
      V - the result type of the final advice
      Parameters:
      aspectId - the aspect id
      Returns:
      the result of final advice

    • hasPathVariables

      boolean hasPathVariables()
      Returns whether the translet name has tokens for extracting parameters or attributes.
      Returns:
      true if the translet name has tokens for extracting parameters or attributes

    • evaluate

      <V> V evaluate(String expression)
      Evaluates a token expression.
      Type Parameters:
      V - the type of evaluation result value
      Parameters:
      expression - the token expression to evaluate
      Returns:
      if there are multiple tokens, the result of evaluating them is returned as a string. If there is only one token, it is returned as is.
      Since:
      7.4.3

    • evaluate

      <V> V evaluate(Token[] tokens)
      Evaluates a token expression.
      Type Parameters:
      V - the type of evaluation result value
      Parameters:
      tokens - the tokens to evaluate
      Returns:
      if there are multiple tokens, the result of evaluating them is returned as a string. If there is only one token, it is returned as is.
      Since:
      7.4.3

    • getBean

      <V> V getBean(String id)
      Return an instance of the bean that matches the given id.
      Type Parameters:
      V - the type of bean object retrieved
      Parameters:
      id - the id of the bean to retrieve
      Returns:
      an instance of the bean

    • getBean

      <V> V getBean(Class<V> type)
      Return an instance of the bean that matches the given object type.
      Type Parameters:
      V - the type of bean object retrieved
      Parameters:
      type - the type the bean must match; can be an interface or superclass. null is disallowed.
      Returns:
      an instance of the bean
      Since:
      1.3.1

    • getBean

      <V> V getBean(Class<V> type, String id)
      Return an instance of the bean that matches the given object type.
      Type Parameters:
      V - the type of bean object retrieved
      Parameters:
      type - type the bean must match; can be an interface or superclass. null is allowed.
      id - the id of the bean to retrieve
      Returns:
      an instance of the bean
      Since:
      2.0.0

    • containsBean

      boolean containsBean(String id)
      Return 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

      boolean containsBean(Class<?> type)
      Return 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

      boolean containsBean(Class<?> type, String id)
      Returns whether the bean corresponding to the specified object type and ID exists.
      Parameters:
      type - the object type of the bean to query
      id - the id of the bean to query
      Returns:
      whether a bean with the specified type is present

    • getMessage

      String getMessage(String code) throws NoSuchMessageException
      Try 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'
      Returns:
      the resolved message
      Throws:
      NoSuchMessageException - if the message wasn't found
      See Also:

    • getMessage

      String getMessage(String code, Object[] args) throws NoSuchMessageException
      Try 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), or null if none.
      Returns:
      the resolved message
      Throws:
      NoSuchMessageException - if the message wasn't found
      See Also:

    • getMessage

      String getMessage(String code, String defaultMessage)
      Try 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.
      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:

    • getMessage

      String getMessage(String code, Object[] args, String defaultMessage)
      Try 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), or null if 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:

    • getMessage

      String getMessage(String code, Locale locale) throws NoSuchMessageException
      Try 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'
      locale - the Locale in which to do the lookup
      Returns:
      the resolved message
      Throws:
      NoSuchMessageException - if the message wasn't found
      See Also:

    • getMessage

      String getMessage(String code, Object[] args, Locale locale) throws NoSuchMessageException
      Try 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), or null if none.
      locale - the Locale in which to do the lookup
      Returns:
      the resolved message
      Throws:
      NoSuchMessageException - if the message wasn't found
      See Also:

    • getMessage

      String getMessage(String code, String defaultMessage, Locale locale)
      Try 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.
      defaultMessage - String to return if the lookup fails
      locale - 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:

    • getMessage

      String getMessage(String code, Object[] args, String defaultMessage, Locale locale)
      Try 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), or null if none.
      defaultMessage - String to return if the lookup fails
      locale - 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: