Package com.aspectran.core.activity

Interface Activity

    • Method Detail

      • prepare

        void prepare​(java.lang.String transletName)
        Prepare for the activity.
        Parameters:
        transletName - the translet name

      • prepare

        void prepare​(TransletRule transletRule)
        Prepare for the activity.
        Parameters:
        transletRule - the translet rule

      • prepare

        void prepare​(java.lang.String transletName,
             TransletRule transletRule)
        Prepare for the activity.
        Parameters:
        transletName - the translet name
        transletRule - the translet rule

      • prepare

        void prepare​(java.lang.String transletName,
             java.lang.String requestMethod)
        Prepare for the activity.
        Parameters:
        transletName - the translet name
        requestMethod - the request method

      • prepare

        void prepare​(java.lang.String transletName,
             MethodType requestMethod)
        Prepare for the activity.
        Parameters:
        transletName - the translet name
        requestMethod - the request method

      • perform

        void perform()
        Performs the prepared activity.

      • finish

        void finish()
        Finish the current activity. It must be called to finish the activity.

      • terminate

        void terminate()
        Throws an ActivityTerminatedException to terminate the current activity.
        Throws:
        ActivityTerminatedException - if an activity terminated without completion

      • terminate

        void terminate​(java.lang.String cause)
        Throws an ActivityTerminatedException with the reason for terminating the current activity.
        Parameters:
        cause - the termination cause
        Throws:
        ActivityTerminatedException - the exception to terminate activity

      • getTranslet

        Translet getTranslet()
        Returns an instance of the current translet.
        Returns:
        an instance of the current translet

      • getProcessResult

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

      • getProcessResult

        java.lang.Object getProcessResult​(java.lang.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:
        an action result

      • 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

      • isIncluded

        boolean isIncluded()
        Returns whether or not contained in other activity.
        Returns:
        true, if this activity is included in the other activity

      • isExceptionRaised

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

      • getRaisedException

        java.lang.Throwable getRaisedException()
        Returns an instance of the currently raised exception.
        Returns:
        an instance of the currently raised exception

      • getRootCauseOfRaisedException

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

      • setRaisedException

        void setRaisedException​(java.lang.Throwable raisedException)
        Sets an instance of the currently raised exception.
        Parameters:
        raisedException - an instance of the currently raised exception

      • clearRaisedException

        void clearRaisedException()

      • registerAspectRule

        void registerAspectRule​(AspectRule aspectRule)
        Register an aspect rule dynamically.
        Parameters:
        aspectRule - the aspect rule

      • registerSettingsAdviceRule

        void registerSettingsAdviceRule​(SettingsAdviceRule settingsAdviceRule)

      • executeAdvice

        void executeAdvice​(java.util.List<AspectAdviceRule> aspectAdviceRuleList,
                   boolean throwable)
        Execute aspect advices with given rules.
        Parameters:
        aspectAdviceRuleList - the aspect advice rules
        throwable - whether to raise an exception

      • executeAdvice

        void executeAdvice​(AspectAdviceRule aspectAdviceRule,
                   boolean throwable)
        Executes an aspect advice with a given rule.
        Parameters:
        aspectAdviceRule - the aspect advice rule
        throwable - whether to raise an exception

      • handleException

        void handleException​(java.util.List<ExceptionRule> exceptionRuleList)
        Exception handling.
        Parameters:
        exceptionRuleList - the exception rule list

      • getSetting

        <T> T getSetting​(java.lang.String settingName)
        Gets the setting value in the translet scope.
        Type Parameters:
        T - the type of the value
        Parameters:
        settingName - the setting name
        Returns:
        the setting value

      • getAspectAdviceBean

        <T> T getAspectAdviceBean​(java.lang.String aspectId)
        Gets the aspect advice bean.
        Type Parameters:
        T - the type of the bean
        Parameters:
        aspectId - the aspect id
        Returns:
        the aspect advice bean object

      • getActivityContext

        ActivityContext getActivityContext()
        Gets the activity context.
        Returns:
        the activity context

      • 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

      • newActivity

        <T extends Activity> T newActivity()
        Create a new inner activity.
        Type Parameters:
        T - the type of the activity
        Returns:
        the activity object