OSGiサービスのプロパティマップへのポートレット記述子

ここでは、OSGiポートレットを発行するためのOSGiサービスプロパティへのポートレットXML記述子の値のマップを示します。 プロパティは、ポートレット設定を一元化および簡素化します。 これらは通常、キーと値のペアとして、またはより一般的にはマップのようなオブジェクトとして表されます。

プロパティキーは、基本的にXML記述子をフラットにしたものですが、記述子の名前に似ています。

マッピングは、記述子タイプごとに編成されています。

• 標準ポートレット記述子。 プロパティキーは、プリフィックスjavax.portletを使用します。

• Liferay記述子記述子。 プロパティキーは、プリフィックスcom.liferay.portletを使用します。 Liferay 記述子は記述子ファイル名によってさらにグループ化されます。

  • liferay-display.xml
  • liferay-portlet.xml

標準のポートレット記述子マッピングが最初です。

ポートレット記述子のマッピング

注意: 簡潔にするために、 ポートレット XSD 4 から派生した XPath 表記が使用されています。

Liferay記述子のマッピング

Liferayディスプレイ

Liferayポートレット

注意: 簡潔にするために、 Liferay Portlet 5 から派生した XPath 表記が使用されています。

• [1] ポートレットは具体的なオブジェクトとして登録されます。

• [2] これらのプロパティの倍数を使用できます。 これにより、値の配列が生成されます。

• [3] このタイプは OSGi サービスとして登録されています。

• [4] https://xmlns.jcp.org/xml/ns/portlet/portlet-app_3_0.xsd

• [5] liferay-portlet-app_[バージョン].dtd

• [6] 複数のjavax.portlet.dependencyプロパティを使用した例を以下に示します。

  旧:

  <portlet>
  	...
  	<dependency>
  		<name>jquery</name>
  		<scope>com.jquery</scope>
  		<version>2.1.1</version>
  	</dependency>
  	<dependency>
  		<name>jsutil</name>
  		<scope>com.mycompany</scope>
  		<version>1.0.0</version>
  	</dependency>
  	...
  </portlet>
  

  新:

  @Component(
      ...
      property = {
          ...
          "javax.portlet.dependency=jquery;com.jquery;2.1.1",
          "javax.portlet.dependency=jsutil;com.mycompany;1.0.0",
          ...
      }, service = Portlet.class
  )
  public class MyPortlet extends GenericPortlet {
      ...
  }
  

• [7] com.liferay.portlet.header-request-attribute-prefixプロパティの例を以下に示します。

  旧:

  <portlet>
  	...
  	<header-request-attribute-prefix>com.mycompany</header-request-attribute-prefix>
  	...
  </portlet>
  

  新:

  @Component(
      property = {
          ...
          "javax.portlet.dependency=jsutil;com.mycompany;1.0.0",
          "com.liferay.portlet.header-request-attribute-prefix=com.mycompany",
          ...
      }, service = Portlet.class
  )
  public class MyPortlet extends GenericPortlet {
      ...
  }
  

• [8] javax.portlet.listenerプロパティの例を以下に示します。

  旧:

  <portlet>
      ...
      <listener>
          <listener-class>com.mycompany.MyPortletURLGenerationListener</listener-class>
          <ordinal>1</ordinal>
      </listener>
      ...
  </portlet>
  

  新:

  @Component(
      property = {
          ...
          "javax.portlet.listener=com.mycompany.MyPortletURLGenerationListener;1",
          ...
      }, service = Portlet.class
  )
  public class MyPortlet extends GenericPortlet {
      ...
  }
  

• [9] javax.portlet.init-paramプロパティは次のように宣言できます。

  @Component(
      ...
      property = {
          ...
          "javax.portlet.init-param.myInitParam=1234",
          ...
      }, service = PortletFilter.class
  )
  public class MyFilter implements RenderFilter {
      ...
  }
  

• [10] Liferayはポートレットの名前に基づいて、各ポートレットのIDを作成します（すなわち、liferay-portlet.xmlのportlet-name記述子またはjavax.portlet.name OSGiサービスのプロパティ）。 ポートレット名にはダッシュ、ピリオド、スペースを使用できますが、これらの文字やその他のJavaScriptの安全でない文字は、ポートレットIDに使用される名前の値から取り除かれます。 したがって、削除される文字を考慮して、ポートレット名を一意なものにしてください。 そうしないと、既にデプロイ済みのポートレットと同じIDのポートレットをデプロイしようとすると、ポートレットのデプロイが失敗し、Liferayは次のメッセージを記録します。

  Portlet id [portletId] is already in use