Writing an Admin Configuration Screen - takumi-memo @ ウィキ

Overview

このチュートリアルでは、多くのAtlassian applicationで使われているadmin UIをどのように作成するのかを紹介します。

これをするために、あなたはRefApp plugin.を作ることでしょう。 (See our page about the Atlassian RefApp.)
紹介するプラグインは次のコンポーネントで構成されています。

• plugin logicをカプセル化しているJava classes
• Resources for display of the plugin UI
• Atlassian　applicationsのplugin moduleを可能にするPlugin descriptor。あｔぁｓ－るｎ

All these components will be contained within a single JAR file. Each component is further discussed in the examples below.

任意のAtlassianアプリケーションで働く方法でpersistence、ユーザ認可および他の共通のタスクに使用することができるサービスのブランチをエクスポートする働きを持つSALを広範囲に利用するでしょう。

形式を与えるために、Atlassian Templete Rendererを使います。
ATRは、Velocity内で、他のプラグインにrender templeteを許可するサービスを提供するプラグインです。

見栄えが良くなるように私たちの形式をデザインするために、およびajaxによってサーバーと通信するために、AUIを使用するでしょう。

To create our REST resources, which our JavaScript will communicate with, we'll use the REST module.
私たちのREST資源(JavasScriptが通信する相手)を作成するために、私たちはRESTモジュールを使用するでしょう。

Create the Plugin Project

まずはプラグインのスケルトンを作成する（いつものことなので割愛）。

   group-id:com.atlassian.plugins.tutorial
   artifact-id:xproduct-admin-ui-plugin
   version:1.0
   package:com.atlassian.plugins.tutorial

Add Plugin Metadata to the POM

ここも割愛

Render the form

admin formレンダリングを得ることから始めましょう。

UI servlet

これは単純な管理の形式をレンダリングするためのサーブレットです。
まずは、pom.xmlにjavax.servletおよびsal-apiのdependencyを加えます。

次にJavaのプログラムを作成していきます。
最初に加えたいことは、ユーザーが管理者かどうかのチェックです。
そのために、SAL UserManagerを使います。

doGetメソッドで、ログインしたユーザーが管理者かどうかチェックします。
もし彼らがログインしていない、または管理者ではない場合、アプリケーションのログインページに転送する手助けをするメソッドを呼び出します。
redirecxtToLoginメソッドです。

redirectToLoginメソッドにはSALから提供された他のサービス、LoginUriProviderを使います。
このサービスは、私たちにアプリケーションのログインページへのURLを構築し、それらがログインした後ユーザーが転送される場所になるURIパラメータを供給することを可能にします。
彼らが適切に認証される場合、ユーザーが渡したちのadmin UIに転送されるように、私たちは彼らに現在のURIを渡します。
さらに、彼らがプラグイン・システムによって注入されるように、コンストラクタにLoginUriProviderを加えました。

さて、私たちの形式を与えるじゅんびは整いました。
Overviewの中で言及された通り、Atlassian Templete Rendererを使用します。
もう一度コードを各前に、それを使用するということをMavenに伝える必要があります。

templeterendererのdependencyをpom.xmlに追加します。

さて、レンダリングを始めましょう。

doGetメソッド内の、先ほど書いたチェックのあとに、レスポンスのコンテント・タイプtext/htmlを設定し、admin.vmをレンダーするためにtempleteRendererの簡単な呼び出しを作成します。

Necessary change to atlassian-plugin.xml

さらに進む前に、サーブレットとdependencyについてのプラグイン・システムを呼び出しておきましょう。
次のモジュールをatlassian-plugin.xmlファイルに追加する必要があります。

それが終わったら、atlas-runコマンドをつかってRefAppのスタートアップをしましょう、
適切なURL先にサーブレットの出力を見ることができるはずです。
しかし、admin.vmファイルを作成していないので、作成しましょう。

Velocity templete

src/main/resources内にadmin.vmファイルを作成してください。

Start weith the basics