Server APIs

package com.tmax.anylink.api.serviceflow;

/**
 * Interface that represents the execution context of an activity
 */

public interface ActivityContext {
    /**
     * @return returns the activity ID.
     */
    String getActivityId();

    /**
     * @return returns the variable context with the specified name as seen in this activity scope.
     */
    VariableContext getVariable(String variableName);

    /**
     * @return returns the context of the service flow that contains this activity.
     */
    ProcessContext getProcessContext();

    /**
     * @return returns the context of the block activity including this activity.
     * If the block activity is not enclosed, null is returned.
     */
    BlockContext getBlockContext();
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.common.AnyLinkException;

/**
 * Handler interface used to handle activity errors
 */

public interface ActivityErrorHandler {
    /**
     * Method called when an error occurs during the execution of an activity in which the handler is defined.
     */
    void handle(ActivityContext context, Throwable error) throws AnyLinkException;
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.common.AnyLinkException;

/**
 * AnyLink activity handler interface.
 * When an object implementing this interface is registered as a handler for the activity,
 * corresponding methods are called according to the life cycle time of the activity instance.
 */

public interface ActivityHandler {
    /**
     * Method called at the start of the activity
     */
    void started(ActivityContext ctx) throws AnyLinkException;

    /**
     * Method called at normal end of the activity
     */
    void finished(ActivityContext ctx) throws AnyLinkException;

    /**
     * Method called when an activity is canceled without being terminated.
     * An activity can be canceled for a number of reasons, usually canceled
     * by another activity or event in the service flow.
     */
    void cancelled(ActivityContext ctx, String cause) throws AnyLinkException;

    /**
     * Method called when the activity is terminated by an error
     */
    void errorOccurred(ActivityContext ctx, Throwable t) throws AnyLinkException;
}

package com.tmax.anylink.api.serviceflow;

/**
 * Interface representing the execution context of a block activity including the currently executed activity.
 */

public interface BlockContext {
    /**
     * @return returns the variable context with the specified name as seen in this block scope.
     */
    VariableContext getVariable(String variableName);

    /**
     * @return returns the execution context of the parent block activity including the block activity.
     * If there is no parent block activity, null is returned.
     */
    BlockContext getParentBlockContext();

    /**
     * @return returns the context of the service flow that contains the block activity.
     */
    ProcessContext getProcessContext();
}

package com.tmax.anylink.api.serviceflow;

/**
 * Interface for converting internal errors into error code that can be recognized by the AnyLink service flow.
 * If the AnyLink service flow does not need to catch all exceptions, it needs to know the error code to handle the error.
 * This interface converts the generated Java objects into error codes so that error events in the service flow can catch them.
 */

public interface ErrorCodeMapper {
    /**
     * @param throwable, the generated Java exception object
     * @return returns the error code value to be handled by the error event of the service flow.
     */
    String getErrorCode(Throwable throwable);
}

package com.tmax.anylink.api.serviceflow;

/**
 * Interface that allows users to write data conversion code in the AnyLink service flow.
 * Used for request, response, abnormal response, and custom log mappings by using user-written code.
 */

public interface UserMapping {
    /**
     * User-written mapping method
     *
     * @param ctx, the current activity context
     * @param inputParams, input parameters are sent via this variable.
     * @return, the mapped result data. The number of result parameters and the array size must be the same.

     */
    Object[] mapping(ActivityContext ctx, Object[] inputParams) throws AnyLinkException;
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.logging.Logger;

/**
 * Interface that represents the execution context of the currently executing service flow
 */

public interface ProcessContext {
    /**
     * @return returns the service flow ID.
     */
    String getProcessId();

    /**
     * @return returns the instance ID of the service flow.
     */
    String getProcessInstanceId();

    /**
     * @return returns the system logger object.
     */
    Logger getUserLogger();

    /**
     * @return returns the variable information of the specified name in the scope of this service flow.
     */
    VariableContext getVariable(String variableName);

    /**
     * Returns the AnyLink execution environment variable value.
     * server.name, cluster.name, bizsystem.id are the currently supported environment variable keys.
     *
     * @param, key environment variable key
     * @return, environment variable value that corresponds to the key
     */
    String getenv(String key);
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.common.AnyLinkException;

/**
 * AnyLink process handler interface.
 * When an object implementing this interface is registered as a handler of the corresponding service flow,
 * the corresponding methods are called according to the lifecycle of the service flow.
 */

public interface ProcessHandler {
    /**
     * Method called when the service flow is started.
     */
    void started(ProcessContext ctx) throws AnyLinkException;

    /**
     * Method called when the service flow is finished.
     */
    void finished(ProcessContext ctx) throws AnyLinkException;

    /**
     * Method called when the service flow is paused. Currently, this method is not used.
     */
    void paused(ProcessContext ctx) throws AnyLinkException;

    /**
     * Method called when the paused service flow is resumed. Currently, this method is not used.
     */
    void resumed(ProcessContext ctx) throws AnyLinkException;
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.api.MessageContext;
import com.tmax.anylink.common.AnyLinkException;

/**
 * AnyLink service activity handler interface.
 * This interface defines additional methods for each point in time in the service call.
 */

public interface ServiceActivityHandler extends ActivityHandler {
    /**
     * Method called just before calling the service.
     */
    void beforeServiceCall(ActivityContext ctx, MessageContext context) throws AnyLinkException;

    /**
     * Method called immediately after calling the service.
     */
    void afterServiceCall(ActivityContext ctx, MessageContext context) throws AnyLinkException;
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.common.AnyLinkException;

/**
 * Interface that represents the user activity.
 * To create a user class activity, users need to create a class that inherits the DefaultUserActivity abstract class that implements this interface.
 */

public interface UserActivity {
    /**
     * Main method that the user activity class should implement.
     */
    void action(ActivityContext ctx) throws AnyLinkException;
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.api.MessageContext;

/**
 * Defines the interface that corresponds to the service flow variable.
 */

public interface VariableContext extends MessageContext {
    /**
     * Specify the variable data.
     *
     * @param content, data to be specified in the variable
     */
    void setContent(Object content);
}