[XMPP] Spark 플러그인 개발하기

1. 들어가기

    XMPP 프로토콜을 지원하는 메시징 클라이언트 Spark는 플러그인 방식으로 새로운 기능을 추가할 수 있도록 한다. 이 문서는 Spark 플러그인을 개발하는 과정을 간략히 정리한 것이다.

2. 개발 환경

    Windows 7 (64-bit)
    JDK 1.6.0_45 (64-bit)
    Ant 1.7.1
    Spark 2.6.3
    Sparkplug Kit 2.0.7

3. Sparkplug Kit 설치

    3.1 다운로드

        아래의 위치에서 Sparkplug Kit 2.0.7을 다운로드한다.

            http://www.igniterealtime.org/builds/sparkplug_kit/sparkplug_kit_2_0_7.zip

    3.2 설치

        압축을 풀고 원하는 위치로 옮긴다.
     
    3.3 sparkplugs\builder\build\build.xml 수정
 
        1) Sparkplug Kit 내에 포함되어 있는 Spark의 API 버전이 낮기 때문에 새로 설치한 Spark 2.6.3을 가리키도록 spark.home 속성의 값을 수정한다.
     
            -    <property name="spark.home" value="${plug.dir}/../spark" />
            +    <property name="spark.home" value="C:\Program Files (x86)\Spark" />
     
        2) javac 태스크의 속성 source와 target의 값이 1.4로 지정되어 있다. 이것을 현재 널리 쓰이고 있는 JDK 버전인 1.6으로 바꾸어 준다. JDK 1.4에서는 generics가 지원되지 않는다.

4. 플러그인 개발

    4.1 플러그인 작성

        단원 "5. 플러그인 작성" 참조.

    4.2 플러그인 빌드
 
        아래와 같이 빌드 명령을 실행하면 sparkplugs\builder\myplugin.jar 파일이 생성될 것이다.

            sparkplugs\builder\build>ant

    4.3 플러그인 설치

        1) sparkplugs\builder\myplugin.jar 파일을 아래 위치로 복사한다.
     
            C:\Program Files (x86)\Spark\plugins
         
        2) Spark를 재시작하고 아래 메뉴를 실행하면 설치한 플러그인들의 목록을 확인할 수 있다.
     
            Spark -> 플러그인

5. 플러그인 작성

    이번 단원에서는 최소한의 파일들만으로 플러그인을 작성해 보았다. 플러그인 작성에 대해 보다 자세히 알아 보고자 한다면 Sparkplug Development Guide를 읽어 보기 바란다.

    5.1 디렉토리 생성

        아래와 같이 하부 디렉토리 구조와 소스 파일을 만든다.

            sparkplugs\builder\src
                com
                    examples
                        plugin
                            MyPlugin.java

    5.2 plugin.xml

        <plugin>
            <name>My Plugin</name>
            <version>1.0</version>
            <author>Your Name</author>
            <homePage>Your Homepage</homePage>
            <email>Your Email Address</email>
            <description>My Plugin Example</description>
            <class>com.examples.plugin.MyPlugin</class>
            <minSparkVersion>2.0.0</minSparkVersion>
        </plugin>

    5.3 MyPlugin.java

        package com.examples.plugin;

        import org.jivesoftware.spark.plugin.Plugin;

        public class MyPlugin implements Plugin {
            /**
             * Called after Spark is loaded to initialize the new plugin.
             */
            public void initialize() {
                System.out.println("Welcome To Spark");
            }

            /**
             * Called when Spark is shutting down to allow for persistence of information
             * or releasing of resources.
             */
            public void shutdown() {

            }

            /**
             * Return true if the Spark can shutdown on users request.
             * @return true if Spark can shutdown on users request.
             */
            public boolean canShutDown() {
                return true;
            }

            /**
            * Is called when a user explicitly asked to uninstall this plugin.
            * The plugin owner is responsible to clean up any resources and
            * remove any components install in Spark.
            */
            public void uninstall(){
               // Remove all resources belonging to this plugin.
            }
        }

6. 참고 자료

    가. Sparkplug Development Guide