
ポートレットの生成
ポートレットテンプレートの生成 #
ポートレットはプラグインSDKを使えば短時間で作成できます。プラグインSDKフォルダ内でポートレット用のフォルダ(portlets)があります。新しいポートレットを作成する場合は、このフォルダ下に作成してください。
ポートレットを作成する場合は、先ずポートレット用のプロジェクト名と表示する題名を決めます(プロジェクト名には空白を含めないでください。表示する題名には空白を含めることは可能です)。
ポートレット名が決まったら、ポートレットの枠を作成することができます。下の例ではプロジェクト名を「my-greeting」、表示する題名を「My Greeting」にしています。コンソール画面を開き、プラグインSDKのポートレットフォルダ(portlets)下に移動し、次のコマンドを実行してください:
(Linux、Mac OS X)
./create.sh my-greeting "My Greeting"
(MS Windows)
./create.sh my-greeting "My Greeting"
antコマンドを実行すると「BUILD SUCCESSFUL」と表示され、ポートレットフォルダに新規に「{プロジェクト名}-portlet」の名前のフォルダが作成されます。そのフォルダ内にポートレットのテンプレート用のフォルダ/ファイルが作成されます。例えば、上の例を実行すると「my-greeting-portlet」フォルダが作成されます。
生成されたファイルをエディタで編集するか、作成されたプロジェクトをIDEに読み込ませて使えます。プラグインSDKのantコマンドを使う場合は、プロジェクトをビルドするときに必要なjarファイルを参照するように記述されていますが、プロジェクトをIDEに読み込む場合はプロジェクトが依存しているjarファイルも読み込む設定が必要です。
ポートレットプロジェクトの依存関係を解決するには、プラグインSDK直下のbuild-common.xmlファイルを参照してください。plugin.classpathとportal.classpathの値を参照して、ポートレットプロジェクトに必要なjarファイルを検出してください。
ヒント:Subversion、CVS、Mercurial、Gitのようなソースコード管理ツールを使う場合は、先ずバージョン管理を行うファイルを明確にすることをお勧めします。デプロイするとソースコード管理ツールの管理から外した方がよいファイルも生成されます。
ポートレットのデプロイ #
Liferayの自動デプロイ機能を使うと、ポートレット(及びその他のプラグイン)を簡単にデプロイできます。warファイルをデプロイ(deploy)フォルダに複写すると、Liferay用に必要な設定の変更を行って、アプリケーションサーバにデプロイします。
ヒント:Liferayは多くの種類のアプリケーションサーバで稼働することができます。TomcatやJBossの場合は、ファイルをフォルダにコピーするとLiferayがアプリケーションサーバにデプロイします。しかし、WebSphereやWeblogicなどの場合は、専用ツールを使ってデプロイする必要があります。
コマンドプロンプトからportlets/my-greeting-portletフォルダに移動して、次のコマンドを実行します:
ant deploy
実行すると「BUILD SUCCESSFUL」と表示され、ポートレットはアプリケーションサーバにデプロイされます。Liferayを起動しているコマンドコンソールに「1 portlet for my-greeting-portlet is available for use」と表示されます。表示されない場合は、デプロイ中にエラーが発生した可能性があります。設定を再確認して、ポートレットを再度デプロイしてください。
Liferayにログインしていない場合は、webブラウザからログインして、メニューから「追加」、「サンプル」を選択して、「My Greeting」の右にある「追加」ボタンを押下してください。作成したポートレットがページに表示されます。
おめでとうございます、初めてのLiferayポートレットを作成しました!