서버 API

package com.tmax.anylink.api.serviceflow;

/**
 * 액티비티의 실행 문맥을 나타내는 인터페이스
 */

public interface ActivityContext {
    /**
     * @return 액티비티 ID를 리턴한다.
     */
    String getActivityId();

    /**
     * @return 이 액티비티 scope에서 보이는 지정된 이름의 변수 문맥을 리턴한다.
     */
    VariableContext getVariable(String variableName);

    /**
     * @return 이 액티비티가 포함된 서비스 플로우의 문맥을 리턴한다.
     */
    ProcessContext getProcessContext();

    /**
     * @return 이 액티비티를 둘러싼 블록 액티비티의 문맥을 리턴한다.
     * 블록 액티비티가 둘러싸고 있지 않다면 null을 리턴한다.
     */
    BlockContext getBlockContext();
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.common.AnyLinkException;

/**
 * 액티비티에서 에러가 발생할 때 이를 처리할 수 있는 핸들러 인터페이스
 */

public interface ActivityErrorHandler {
    /**
     * 핸들러가 정의된 액티비티 실행 도중 어떤 에러가 발생하면 호출되는 메소드
     */
    void handle(ActivityContext context, Throwable error) throws AnyLinkException;
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.common.AnyLinkException;

/**
 * AnyLink 액티비티 핸들러 인터페이스.
 * 이 인터페이스를 구현한 객체를 해당 액티비티의 핸들러로 등록하면
 * 액티비티 인스턴스의 라이프사이클 시점에 맞추어 대응하는 메소드들이 각각 호출된다.
 */

public interface ActivityHandler {
    /**
     * 액티비티 시작 시점에서 호출되는 메소드
     */
    void started(ActivityContext ctx) throws AnyLinkException;

    /**
     * 액티비티 정상 종료 시점에서 호출되는 메소드
     */
    void finished(ActivityContext ctx) throws AnyLinkException;

    /**
     * 액티비티가 종료되지 않고 취소될 때 호출되는 메소드.
     * 액티비티는 몇 가지 이유로 취소될 수 있는데 주로 서비스 플로우 내의
     * 다른 액티비티나 이벤트에 의해 취소된다.
     */
    void cancelled(ActivityContext ctx, String cause) throws AnyLinkException;

    /**
     * 액티비티가 어떤 에러에 의해 종료될 때 호출되는 메소드
     */
    void errorOccurred(ActivityContext ctx, Throwable t) throws AnyLinkException;
}

package com.tmax.anylink.api.serviceflow;

/**
 * 현재 수행되는 액티비티를 둘러싸고 있는 블록 액티비티의 실행 문맥을 나타내는 인터페이스
 */

public interface BlockContext {
    /**
     * @return 이 블록 scope에서 보이는 지정된 이름의 변수 문맥을 리턴한다.
     */
    VariableContext getVariable(String variableName);

    /**
     * @return 이 블록 액티비티를 둘러싸고 있는 부모 블록 액티비티의 실행 문맥을 리턴한다.
     * 둘러싸고 있는 부모 블록 액티비티가 없다면 null을 리턴한다.
     */
    BlockContext getParentBlockContext();

    /**
     * @return 이 블록 액티비티가 포함된 서비스 플로우의 문맥을 리턴한다.
     */
    ProcessContext getProcessContext();
}

package com.tmax.anylink.api.serviceflow;

/**
 * 내부적으로 발생한 에러를 AnyLink 서비스 플로우가 이해하는
 * 에러 코드로 변환해주기 위한 인터페이스이다.
 * AnyLink 서비스 플로우는 모든 예외를 잡으려고 하지 않을 경우에는
 * 에러를 처리하기 위해 에러 코드를 알 필요가 있다.
 * 이 인터페이스는 발생한 자바 객체를 서비스 플로우의 에러 이벤트가 잡을 수 있도록
 * 에러 코드로 변환해주는 역할을 한다.
 */

public interface ErrorCodeMapper {
    /**
     * @param throwable 발생한 자바 예외 객체
     * @return 서비스 플로우의 에러 이벤트가 처리할 에러 코드값
     */
    String getErrorCode(Throwable throwable);
}

package com.tmax.anylink.api.serviceflow;

/**
 * AnyLink 서비스 플로우 내에서 사용자가 직접 데이터 값을
 * 변환하는 코드를 작성할 수 있게 해주는 인터페이스이다.
 * 요청 매핑, 응답 매핑, 비정상 응답 매핑, 커스텀 로그 매핑 등에서
 * 사용자가 직접 작성한 코드를 사용하여 매핑하고자 할 때 사용한다.
 */

public interface UserMapping {
    /**
     * 사용자 작성 매핑 메소드
     *
     * @param ctx 현재 액티비티 컨텍스트
     * @param inputParams 입력 파라미터들이 이 변수를 통해 전달된다
     * @return 매핑한 결과 데이터. 결과 파라미터 목록 갯수와 배열 크기가 같아야 한다.
     */
    Object[] mapping(ActivityContext ctx, Object[] inputParams) throws AnyLinkException;
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.logging.Logger;

/**
 * 현재 실행되는 서비스 플로우의 실행 문맥을 나타내는 인터페이스
 */

public interface ProcessContext {
    /**
     * @return 서비스 플로우 ID를 리턴한다.
     */
    String getProcessId();

    /**
     * @return 서비스 플로우의 인스턴스 ID를 리턴한다.
     */
    String getProcessInstanceId();

    /**
     * @return 시스템 로거 객체를 리턴한다.
     */
    Logger getUserLogger();

    /**
     * @return 이 서비스 플로우의 scope에서 지정된 이름의 변수 정보를 리턴한다.
     */
    VariableContext getVariable(String variableName);

    /**
     * AnyLink 실행 환경 변수 값을 리턴한다.
     * server.name, cluster.name, bizsystem.id 등이 현재 지원되는 환경 변수 키이다.
     *
     * @param key 환경변수 키
     * @return 키에 해당하는 환경변수 값
     */
    String getenv(String key);
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.common.AnyLinkException;

/**
 * AnyLink 프로세스 핸들러 인터페이스.
 * 이 인터페이스를 구현한 객체를 해당 서비스 플로우의 핸들러로 등록하면
 * 서비스 플로우의 각 라이프사이클 시점에 맞추어 대응하는 메소드들이 각각 호출된다.
 */

public interface ProcessHandler {
    /**
     * 서비스 플로우가 시작할 때 호출되는 메소드
     */
    void started(ProcessContext ctx) throws AnyLinkException;

    /**
     * 서비스 플로우가 종료할 때 호출되는 메소드
     */
    void finished(ProcessContext ctx) throws AnyLinkException;

    /**
     * 서비스 플로우가 일시 중지될 때 호출되는 메소드. 이 메소드는 현재 사용되지 않는다.
     */
    void paused(ProcessContext ctx) throws AnyLinkException;

    /**
     * 일시 중지된 서비스 플로우가 재개될 때 호출되는 메소드. 이 메소드는 현재 사용되지 않는다.
     */
    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 서비스 액티비티 핸들러 인터페이스.
 * 이 인터페이스는 ActivityHandler 인터페이스에 더하여
 * 서비스 호출의 각 시점에 해당하는 추가적인 메소드들을 정의한다.
 */

public interface ServiceActivityHandler extends ActivityHandler {
    /**
     * 해당 서비스를 호출하기 직전에 호출되는 메소드
     */
    void beforeServiceCall(ActivityContext ctx, MessageContext context) throws AnyLinkException;

    /**
     * 해당 서비스가 호출된 직후에 호출되는 메소드
     */
    void afterServiceCall(ActivityContext ctx, MessageContext context) throws AnyLinkException;
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.common.AnyLinkException;

/**
 * 사용자 액티비티를 표현하는 인터페이스.
 * 사용자 클래스 액티비티를 만들려면 사용자들은 이 인터페이스를 구현한
 * DefaultUserActivity 추상 클래스를 상속하는 클래스를 작성하여 지정하면 된다.
 */

public interface UserActivity {
    /**
     * 사용자 액티비티 클래스가 구현해야 할 주 메소드
     */
    void action(ActivityContext ctx) throws AnyLinkException;
}

package com.tmax.anylink.api.serviceflow;

import com.tmax.anylink.api.MessageContext;

/**
 * 서비스 플로우의 변수에 해당하는 인터페이스를 정의한다.
 */

public interface VariableContext extends MessageContext {
    /**
     * 변수 데이터를 지정한다
     *
     * @param content 변수에 지정할 데이터
     */
    void setContent(Object content);
}