Package com.aspectran.embed.service

Interface EmbeddedAspectran

All Known Implementing Classes:
AbstractEmbeddedAspectran, DefaultEmbeddedAspectran
public interface EmbeddedAspectran
The Interface EmbeddedAspectran.

Created: 2017. 10. 28.

  • Method Details

    • isExposable

      boolean isExposable(String transletName)
      Returns whether the translet can be exposed to the daemon service.
      Parameters:
      transletName - the name of the translet to check
      Returns:
      true if the translet can be exposed; false otherwise

    • execute

      <V> V execute(InstantAction<V> instantAction)
      Executes an instant activity.
      Parameters:
      instantAction - the instant action
      Returns:
      An object that is the result of performing an instant activity
      Since:
      6.5.1

    • translate

      Translet translate(String name)
      Executes the translet.
      Parameters:
      name - the translet name
      Returns:
      the Translet object

    • translate

      Translet translate(String name, String body)
      Executes the translet.
      Parameters:
      name - the translet name
      body - the request body
      Returns:
      the Translet object

    • translate

      Translet translate(String name, Map<String,Object> attributeMap)
      Executes the translet with the given parameters.
      Parameters:
      name - the translet name
      attributeMap - the attribute map
      Returns:
      the Translet object

    • translate

      Translet translate(String name, ParameterMap parameterMap)
      Executes the translet with the given parameters.
      Parameters:
      name - the translet name
      parameterMap - the parameter map
      Returns:
      the Translet object

    • translate

      Translet translate(String name, Map<String,Object> attributeMap, ParameterMap parameterMap)
      Executes the translet with the given attributes and parameters.
      Parameters:
      name - the translet name
      attributeMap - the attribute map
      parameterMap - the parameter map
      Returns:
      the Translet object

    • translate

      Translet translate(String name, MethodType method)
      Executes the translet without the supplied variables.
      Parameters:
      name - the translet name
      method - the request method
      Returns:
      the Translet object

    • translate

      Translet translate(String name, MethodType method, Map<String,Object> attributeMap)
      Executes the translet with the given attributes.
      Parameters:
      name - the translet name
      method - the request method
      attributeMap - the attribute map
      Returns:
      the Translet object

    • translate

      Translet translate(String name, MethodType method, ParameterMap parameterMap)
      Executes the translet with the given parameters.
      Parameters:
      name - the translet name
      method - the request method
      parameterMap - the parameter map
      Returns:
      the Translet object

    • translate

      Translet translate(String name, MethodType method, Map<String,Object> attributeMap, ParameterMap parameterMap)
      Executes the translet with the given attributes and parameters.
      Parameters:
      name - the translet name
      method - the request method
      attributeMap - the attribute map
      parameterMap - the parameter map
      Returns:
      the Translet object

    • translate

      Translet translate(String name, MethodType method, Map<String,Object> attributeMap, ParameterMap parameterMap, String body)
      Executes the translet with the given attributes and parameters.
      Parameters:
      name - the translet name
      method - the request method
      attributeMap - the attribute map
      parameterMap - the parameter map
      body - the request body
      Returns:
      the Translet object

    • render

      String render(String templateId)
      Renders the template without the supplied variables.
      Parameters:
      templateId - the template id
      Returns:
      the output string of the template

    • render

      String render(String templateId, Map<String,Object> attributeMap)
      Renders the template with the given attributes.
      Parameters:
      templateId - the template id
      attributeMap - the attribute map
      Returns:
      the output string of the template

    • render

      String render(String templateId, ParameterMap parameterMap)
      Renders the template with the given parameters.
      Parameters:
      templateId - the template id
      parameterMap - the parameter map
      Returns:
      the output string of the template

    • render

      String render(String templateId, Map<String,Object> attributeMap, ParameterMap parameterMap)
      Renders the template with the given attributes and parameters.
      Parameters:
      templateId - the template id
      attributeMap - the attribute map
      parameterMap - the parameter map
      Returns:
      the output string of the template

    • getEnvironment

      Environment getEnvironment()
      Gets the environment.
      Returns:
      the environment

    • getApplicationAdapter

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

    • 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, 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, 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:

    • newSessionAdapter

      SessionAdapter newSessionAdapter()
      Create and return a new session adapter from the embedded aspectran.
      Returns:
      the session adapter

    • release

      void release()
      Stop the service and release all allocated resources.

    • run

      @NonNull static EmbeddedAspectran run(String aspectranConfigFile)
      Creates and starts a new DefaultEmbeddedAspectran.
      Parameters:
      aspectranConfigFile - the aspectran configuration file
      Returns:
      the instance of EmbeddedAspectran

    • run

      @NonNull static EmbeddedAspectran run(File aspectranConfigFile)
      Creates and starts a new DefaultEmbeddedAspectran.
      Parameters:
      aspectranConfigFile - the aspectran configuration file
      Returns:
      the instance of EmbeddedAspectran

    • run

      @NonNull static EmbeddedAspectran run(Reader configFileReader)
      Creates and starts a new DefaultEmbeddedAspectran.
      Parameters:
      configFileReader - the aspectran configuration file reader
      Returns:
      the instance of EmbeddedAspectran

    • run

      @NonNull static EmbeddedAspectran run(AspectranConfig aspectranConfig)
      Creates and starts a new DefaultEmbeddedAspectran.
      Parameters:
      aspectranConfig - the parameters for aspectran configuration
      Returns:
      the instance of EmbeddedAspectran