カスタムコード品質ルール custom-code-quality-rules

徹底的なテストを通じて高品質のコードを保証するための、Adobe Experience Manager エンジニアリングのベストプラクティスに基づく Cloud Manager のカスタムコード品質ルールについて説明します。コード品質テストも参照してください。

SonarQube ルール sonarqube-rules

以下の節では、Cloud Manager で実行される SonarQube ルールについて説明します。

問題が発生する可能性がある関数は使用しない do-not-use-potentially-dangerous-functions

Thread.stop() と Thread.interrupt() のメソッドは、再現が困難な問題を引き起こし、場合によってはセキュリティの脆弱性を生み出す可能性があります。その使用状況は、厳密に監視および検証する必要があります。一般的に、似た目標を達成するにはメッセージを渡すとより安全です。

非準拠コード non-compliant-code

public class DontDoThis implements Runnable {
  private Thread thread;

  public void start() {
    thread = new Thread(this);
    thread.start();
  }

  public void stop() {
    thread.stop();  // UNSAFE!
  }

  public void run() {
    while (true) {
        somethingWhichTakesAWhileToDo();
    }
  }
}

準拠コード compliant-code

public class DoThis implements Runnable {
  private Thread thread;
  private boolean keepGoing = true;

  public void start() {
    thread = new Thread(this);
    thread.start();
  }

  public void stop() {
    keepGoing = false;
  }

  public void run() {
    while (this.keepGoing) {
        somethingWhichTakesAWhileToDo();
    }
  }
}

外部で制御できる可能性のある書式指定文字列を使用しない do-not-use-format-strings-which-may-be-externally-controlled

外部ソース（リクエストパラメーターやユーザー生成コンテンツなど）の書式指定文字列を使用すると、アプリケーションがサービス拒否（DoS）攻撃にさらされる可能性があります。書式指定文字列は外部で制御できる場合がありますが、信頼できるソースからのみ許可されます。

非準拠コード non-compliant-code-1

protected void doPost(SlingHttpServletRequest request, SlingHttpServletResponse response) {
  String messageFormat = request.getParameter("messageFormat");
  request.getResource().getValueMap().put("some property", String.format(messageFormat, "some text"));
  response.sendStatus(HttpServletResponse.SC_OK);
}

HTTP 要求には常にソケットおよび接続タイムアウトが必要 http-requests-should-always-have-socket-and-connect-timeouts

Experience Manager アプリケーション内で HTTP リクエストを行う場合、不要なスレッドの使用を防ぐために適切なタイムアウトを設定することが重要です。
デフォルトでは、Java™ HTTP クライアント（java.net.HttpUrlConnection）と広く使用されている Apache HTTP コンポーネントクライアントはどちらもタイムアウトを適用しないので、手動で設定する必要があります。ベストプラクティスとして、タイムアウトは 60 秒以下に設定する必要があります。

非準拠コード non-compliant-code-2

@Reference
private HttpClientBuilderFactory httpClientBuilderFactory;

public void dontDoThis() {
  HttpClientBuilder builder = httpClientBuilderFactory.newBuilder();
  HttpClient httpClient = builder.build();

  // do something with the client
}

public void dontDoThisEither() {
  URL url = new URL("http://www.google.com");
  URLConnection urlConnection = url.openConnection();

  BufferedReader in = new BufferedReader(new InputStreamReader(
    urlConnection.getInputStream()));

  String inputLine;
  while ((inputLine = in.readLine()) != null) {
    logger.info(inputLine);
  }

  in.close();
}

準拠コード compliant-code-1

@Reference
private HttpClientBuilderFactory httpClientBuilderFactory;

public void doThis() {
  HttpClientBuilder builder = httpClientBuilderFactory.newBuilder();
  RequestConfig requestConfig = RequestConfig.custom()
    .setConnectTimeout(5000)
    .setSocketTimeout(5000)
    .build();
  builder.setDefaultRequestConfig(requestConfig);

  HttpClient httpClient = builder.build();

  // do something with the client
}

public void orDoThis () {
  URL url = new URL("http://www.google.com");
  URLConnection urlConnection = url.openConnection();
  urlConnection.setConnectTimeout(5000);
  urlConnection.setReadTimeout(5000);

  BufferedReader in = new BufferedReader(new InputStreamReader(
    urlConnection.getInputStream()));

  String inputLine;
  while ((inputLine = in.readLine()) != null) {
    logger.info(inputLine);
  }

  in.close();
}

常に ResourceResolver オブジェクトを閉じる resourceresolver-objects-should-always-be-closed

ResourceResolverFactory から取得された ResourceResolver オブジェクトは、システムリソースを使用します。ResourceResolver が使用されなくなった場合に、これらのリソースを再利用する指標がありますが、close() メソッドを呼び出し、開いている ResourceResolver オブジェクトを明示的に閉じるほうが効率的です。

一般的な誤解として、既存の JCR セッションを使用して作成された ResourceResolver オブジェクトは明示的に閉じることはできず、そうすると JCR セッションに影響するというものがあります。この情報は正しくありません。ResourceResolver は不要になったときは、必ず閉じる必要があります。ResourceResolver は Closeable インターフェイスを実装するので、close() を直接呼び出す代わりに、try-with-resources 構文を使用することもできます。

非準拠コード non-compliant-code-4

public void dontDoThis(Session session) throws Exception {
  ResourceResolver resolver = factory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object)session));
  // do some stuff with the resolver
}

準拠コード compliant-code-2

public void doThis(Session session) throws Exception {
  ResourceResolver resolver = null;
  try {
    resolver = factory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object)session));
    // do something with the resolver
  } finally {
    if (resolver != null) {
      resolver.close();
    }
  }
}

public void orDoThis(Session session) throws Exception {
  try (ResourceResolver resolver = factory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object) session))){
    // do something with the resolver
  }
}

サーブレットの登録に Sling サーブレットパスを使用しない do-not-use-sling-servlet-paths-to-register-servlets

Sling ドキュメントで説明されているように、パスによってサーブレットをバインドすることは推奨されません。パスバインドサーブレットでは、標準 JCR アクセス制御を使用できないので、追加のセキュリティをより厳格にする必要があります。パスバインドサーブレットを使用する代わりに、リポジトリにノードを作成し、リソースタイプによってサーブレットを登録することをお勧めします。

非準拠コード non-compliant-code-5

@Component(property = {
  "sling.servlet.paths=/apps/myco/endpoint"
})
public class DontDoThis extends SlingAllMethodsServlet {
 // implementation
}

キャッチされた例外は、ログに記録またはスローする必要があるが、両方は行わない caught-exceptions-should-be-logged-or-thrown-but-not-both

一般に、例外は 1 回だけログに記録する必要があります。例外を複数回ログに記録すると、混乱を招く可能性があります。例外が発生した回数が不明なためです。この影響を引き起こす最も一般的なパターンは、キャッチされた例外をログに記録してスローすることです。

非準拠コード non-compliant-code-6

public void dontDoThis() throws Exception {
  try {
    someOperation();
  } catch (Exception e) {
    logger.error("something went wrong", e);
    throw e;
  }
}

準拠コード compliant-code-3

public void doThis() {
  try {
    someOperation();
  } catch (Exception e) {
    logger.error("something went wrong", e);
  }
}

public void orDoThis() throws MyCustomException {
  try {
    someOperation();
  } catch (Exception e) {
    throw new MyCustomException(e);
  }
}

ログステートメントの直後にスローステートメントを使用しない avoid-having-a-log-statement-immediately-followed-by-a-throw-statement

もうひとつの避けるべき一般的なパターンは、メッセージをログに記録してからすぐに例外をスローすることです。これは一般に、ログファイルで例外メッセージが重複することを示します。

非準拠コード non-compliant-code-7

public void dontDoThis() throws Exception {
  logger.error("something went wrong");
  throw new RuntimeException("something went wrong");
}

準拠コード compliant-code-4

public void doThis() throws Exception {
  throw new RuntimeException("something went wrong");
}

GET または HEAD 要求の処理時に INFO でログに記録しない avoid-logging-at-info-when-handling-get-or-head-requests

一般的に、INFO ログレベルは重要なアクションを区切るために使用し、デフォルトでは、Experience Manager は INFO レベル以上をログに記録するように設定されています。GET および HEAD メソッドは読み取り専用操作に過ぎず、重要なアクションを構成しません。GET または HEAD 要求に応答して INFO レベルでログに記録すると、大量のログノイズが作成されるので、ログファイル内の有用な情報を特定するのが難しくなります。GET または HEAD リクエストを処理する際に、問題が発生した場合は、WARN または ERROR レベルでログを記録します。詳細なトラブルシューティング情報が必要な場合は、DEBUG または TRACE レベルを使用してください。

非準拠コード non-compliant-code-8

public void doGet() throws Exception {
  logger.info("handling a request from the user");
}

準拠コード compliant-code-5

public void doGet() throws Exception {
  logger.debug("handling a request from the user.");
}

Exception.getMessage() をログステートメントの最初のパラメーターとして使用しない do-not-use-exception-getmessage-as-the-first-parameter-of-a-logging-statement

ベストプラクティスとして、ログメッセージは、アプリケーション内での問題の発生場所に関するコンテキスト情報を提供する必要があります。また、スタックトレースを使用してコンテキストを判断することもできます。これにより、一般的にログメッセージが読みやすく、わかりやすくなります。その結果、例外をログに記録する際に、例外のメッセージをログメッセージとして使用するのは適切ではありません。例外メッセージには何が問題だったかが記載されますが、ログメッセージは、例外が発生したときにアプリケーションが何を実行していたかをリーダーに通知する必要があります。例外メッセージはログに記録されます。独自のメッセージを指定すると、ログがわかりやすくなります。

非準拠コード non-compliant-code-9

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error(e.getMessage(), e);
  }
}

準拠コード compliant-code-6

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

catch ブロックのログは、WARN または ERROR レベルにする必要がある logging-in-catch-blocks-should-be-at-the-warn-or-error-level

名前が示すように、Java™ の例外は常に例外的な状況で使用する必要があります。結果として、例外が検出されたときには、ログメッセージが適切なレベル（WARN または ERROR）で記録されるようにすることが重要です。このプロセスにより、これらのメッセージがログに正しく表示されます。

非準拠コード non-compliant-code-10

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.debug(e.getMessage(), e);
  }
}

準拠コード compliant-code-7

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

コンソールにスタックトレースをプリントしない do-not-print-stack-traces-to-the-console

既に述べたように、コンテキストはログメッセージを理解する場合に重要です。Exception.printStackTrace() を使用すると、スタックトレースのみが標準エラーストリームに出力されるので、すべてのコンテキストが失われます。さらに、Experience Manager などのマルチスレッドアプリケーションで、このメソッドを同時に使用して複数の例外が出力される場合、スタックトレースが重なって大きな混乱を招くことがあります。例外は、ログフレームワークによってのみ記録される必要があります。

非準拠コード non-compliant-code-11

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    e.printStackTrace();
  }
}

準拠コード compliant-code-8

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

標準出力または標準エラーに出力しない do-not-output-to-standard-output-or-standard-error

Experience Manager にログインする場合は、常にログフレームワーク（SLF4J）を使用してログインする必要があります。標準出力または標準エラーストリームに直接出力すると、ログフレームワークによって提供される構造およびコンテキスト情報が失われます。場合によっては、パフォーマンスの問題が発生することがあります。

非準拠コード non-compliant-code-12

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    System.err.println("Unable to do something");
  }
}

準拠コード compliant-code-9

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

apps および libs パスをハードコーディングしない avoid-hardcoded-apps-and-libs-paths

/libs および /apps で始まるパスは一般的にハードコードするべきではありません。これらのパスは通常、Sling 検索パス（デフォルトは /libs,/apps）に関連して保存されます。絶対パスを使用すると、プロジェクトライフサイクルの後になって初めて現れる、わかりにくい不具合が生じる可能性があります。

非準拠コード non-compliant-code-13

public boolean dontDoThis(Resource resource) {
  return resource.isResourceType("/libs/foundation/components/text");
}

準拠コード compliant-code-10

public void doThis(Resource resource) {
  return resource.isResourceType("foundation/components/text");
}

Sling スケジューラーを使用しない sonarqube-sling-scheduler

確実な実行を必要とするタスクには、 Sling スケジューラーを使用しないでください。Sling スケジュールジョブは実行を保証し、クラスター化環境と非クラスター化環境の両方に適しています。

Sling ジョブがクラスター環境で処理される方法について詳しくは、Apache Sling のイベントとジョブの取り扱いを参照してください。

Experience Manager の非推奨 API は使用しない sonarqube-aem-deprecated

Experience Manager API のサーフェスは、使用が勧められず、非推奨と見なされる API を識別するため、継続的に改訂されます。

多くの場合、これらの API は、標準の Java™ @Deprecated 注釈を使用して非推奨とされ、その結果、squid:CallToDeprecatedMethod によって識別されます。

ただし、API が Experience Manager のコンテキストで非推奨となるものの、他のコンテキストでは非推奨とならない場合があります。このルールは、この 2 番目のクラスを識別します。

Sling モデルで @Inject 注釈を @Optional と共に使用しない sonarqube-slingmodels-inject-optional

Apache Sling プロジェクトでは、Sling モデルのコンテキストでの @Inject 注釈の使用を推薦しません。DefaultInjectionStrategy.OPTIONAL と組み合わされた場合（フィールドまたはクラスレベルで）、パフォーマンスが悪くなるからです。代わりに、より具体的なインジェクション（@ValueMapValue または @OsgiInjector 注釈など）を使用する必要があります。

推薦される注釈に関して、そして、そもそもなぜこのような推薦がされたのかに関しての詳細は、Apache Sling ドキュメントを参照してください。

HTTPClient のインスタンスを再利用 sonarqube-reuse-httpclient

AEM アプリケーションは 、HTTP プロトコルを使用している他のアプリケーションに接続することが多く、Apache HttpClient はこの目的でよく使用されるライブラリです。しかし、このような HttpClient オブジェクトを作成する際にはオーバーヘッドが発生するので、これらのオブジェクトはできる限り再利用する必要があります。

このルールは、HttpClient オブジェクトがメソッド内でプライベートではなく、クラスレベルでグローバルであることを確認するので、再利用が可能になります。この場合、HttpClient フィールドは、クラスのコンストラクターか activate() メソッド（このクラスが OSGi コンポーネント／サービスの場合）で設定される必要があります。

HttpClient の使用に関するベストプラクティスに関しては、HttpClient の最適化ガイドを確認してください。

非準拠コード non-compliant-code-14

public void doHttpCall() {
  HttpClient httpclient = HttpClients.createDefault();
  // do something with the httpclient
}

準拠コード compliant-code-11

public class myClass {

  HttpClient httpclient;

  public void doHttpCall() {
    // do something with the httpclient
  }

}

OakPAL コンテンツルール oakpal-rules

以下の節では、Cloud Manager が実行する OakPAL チェックについて説明します。

お客様は、@ProviderType の注釈が付いた製品 API を実装または拡張しないでください product-apis-annotated-with-providertype-should-not-be-implemented-or-extended-by-customers

Experience Manager API には、カスタムコードで使用するだけで実装できない、Java™ インターフェイスとクラスが含まれています。例えば、com.day.cq.wcm.api.Page インターフェイスを実装するのは Experience Manage のみにしてください。

新しいメソッドがこれらのインターフェイスに追加された場合、これらのインターフェイスを使用する既存のコードには、これらの追加のメソッドは影響しません。その結果、これらのインターフェイスに新しいメソッドが追加された場合、後方互換性があると見なされます。ただし、カスタムコードがこれらのインターフェイスのいずれかを実装する場合、そのカスタムコードによってお客様に後方互換性のリスクがもたらされます。

インターフェイスとクラス（Experience Manager によって実装される）には、org.osgi.annotation.versioning.ProviderType または場合によっては従来の類似の注釈 aQute.bnd.annotation.ProviderType が付けられます。このルールでは、カスタムコードがこのようなインターフェイスを実装したり、クラスを拡張したりするケースを特定します。

非準拠コード non-compliant-code-3

import com.day.cq.wcm.api.Page;

public class DontDoThis implements Page {
// implementation here
}

カスタム Lucene Oak インデックスには Tika 設定が必要 oakpal-indextikanode

標準提供の複数の Experience Manager Oak インデックスには Tika 設定が含まれており、これらのインデックスをカスタマイズする場合は Tika 設定を含める必要があります。このルールは、damAssetLucene、lucene、graphqlConfig インデックスのカスタマイズを確認し、tika ノードがない場合、または tika ノードに config.xml という名前の子ノードがない場合には問題を報告します。

インデックス定義のカスタマイズについて詳しくは、インデックス作成に関するドキュメントを参照してください。

非準拠コード non-compliant-code-indextikanode

+ oak:index
    + damAssetLucene-1-custom
      - async: [async]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene

準拠コード compliant-code-indextikanode

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

カスタム Lucene Oak インデックスは同期してはいけない oakpal-indexasync

lucene タイプの Oak インデックスは常に非同期でインデックスを作成する必要があります。そうしない場合、システムが不安定になる可能性があります。Lucene インデックスの構造について詳しくは、Oak のドキュメントを参照してください。

非準拠コード non-compliant-code-indexasync

+ oak:index
    + damAssetLucene-1-custom
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - type: lucene
      - tags: [visualSimilaritySearch]
      + tika
        + config.xml

準拠コード compliant-code-indexasync

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

カスタム DAM Asset Lucene Oak インデックスが正しく構造化されている oakpal-damAssetLucene-sanity-check

Experience Manager Assets でアセット検索が正しく機能するようにするには、damAssetLucene Oak インデックスのカスタマイズはこのインデックスに固有の一連のガイドラインに従う必要があります。このルールは、インデックス定義に tags という複数の値を持つプロパティがあって visualSimilaritySearch という値を含むかどうかを確認します。

非準拠コード non-compliant-code-damAssetLucene

+ oak:index
    + damAssetLucene-1-custom
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - type: lucene
      + tika
        + config.xml

準拠コード compliant-code-damAssetLucene

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

顧客パッケージでは libs 下のノードを作成または変更しない oakpal-customer-package

Experience Manager コンテンツリポジトリ内の /libs コンテンツツリーを読み取り専用と見なすことは、長年のベストプラクティスとなっています。/libs の下のノードやプロパティを変更すると、メジャーアップデートやマイナーアップデートの際に重大な問題が発生する可能性があります。公式チャネルを通じて Adobe を使用し、/libs に変更を加えます。

パッケージには重複する OSGi 設定を含めない oakpal-package-osgi

複雑なプロジェクトでよく発生する問題は、同じ OSGi コンポーネントが複数回設定されることです。この問題により、どの設定が適用可能かがあいまいになります。このルールは「実行モード対応」です。つまり、同じコンポーネントが同じ実行モード（または実行モードの組み合わせ）で複数回設定されている問題のみを特定します。

非準拠コード non-compliant-code-osgi

+ apps
  + projectA
    + config
      + com.day.cq.commons.impl.ExternalizerImpl
  + projectB
    + config
      + com.day.cq.commons.impl.ExternalizerImpl

準拠コード compliant-code-osgi

+ apps
  + shared-config
    + config
      + com.day.cq.commons.impl.ExternalizerImpl

config および install フォルダーには OSGi ノードのみを含める oakpal-config-install

セキュリティ上の理由から、/config/ と /install/ を含むパスを判読できるのは Experience Manager の管理者ユーザーのみとなっており、これらのパスは OSGi 設定と OSGi バンドルにのみ使用する必要があります。これらのセグメントを含むパスの下に他のタイプのコンテンツを配置すると、管理者ユーザーと非管理者ユーザーの間で、意図せずアプリケーションの動作が異なってしまいます。

よくある問題としては、コンポーネントダイアログ内や、インライン編集にリッチテキストエディター設定を指定する際に、config というノードを使用するケースがあります。この問題を解決するには、問題のノードを準拠した名前に変更する必要があります。リッチテキストエディター設定については、cq:inplaceEditing ノードの configPath プロパティを使用して新しい場所を指定します。

非準拠コード non-compliant-code-config-install

+ cq:editConfig [cq:EditConfig]
  + cq:inplaceEditing [cq:InplaceEditConfig]
    + config [nt:unstructured]
      + rtePlugins [nt:unstructured]

準拠コード compliant-code-config-install

+ cq:editConfig [cq:EditConfig]
  + cq:inplaceEditing [cq:InplaceEditConfig]
    ./configPath = inplaceEditingConfig (String)
    + inplaceEditingConfig [nt:unstructured]
      + rtePlugins [nt:unstructured]

パッケージは重複させない oakpal-no-overlap

パッケージには重複する OSGi 設定ルールを含めないと同様に、この状況は、複雑なプロジェクトでよく発生する問題です。複数の異なるコンテンツパッケージに同じノードパスが書き込まれるケースです。コンテンツパッケージの依存関係を使用すると、一貫性のある結果を得ることができますが、その際には、パッケージがまったく重複しないようにすることをお勧めします。

デフォルトのオーサリングモードをクラシック UI にしない oakpal-default-authoring

OSGi 設定 com.day.cq.wcm.core.impl.AuthoringUIModeServiceImpl は、Experience Manager 内でデフォルトのオーサリングモードを定義します。Experience Manager 6.4 以降、クラシック UI は非推奨となったため、デフォルトのオーサリングモードがクラシック UI に設定されている場合、問題が発生するようになりました。

ダイアログを使用したコンポーネントにはタッチ UI ダイアログが必要 oakpal-components-dialogs

クラシック UI ダイアログを持つ Experience Manager コンポーネントには、対応するタッチ UI ダイアログが常に必要です。どちらも、最適なオーサリングエクスペリエンスを提供し、クラシック UI がサポートされなくなった Cloud Service デプロイメントモデルとの互換性を持たせます。このルールは、次のシナリオを検証します。

Experience Manager 最新化ツールのドキュメントには、コンポーネントをクラシック UI からタッチ UI に変換する方法に関するドキュメントとツールが記載されています。詳しくは、Experience Manager 最新化ツールのドキュメントを参照してください。

可変コンテンツと不変コンテンツがパッケージ内に混在してはならない oakpal-packages-immutable

Cloud Service デプロイメントモデルとの互換性を保つには、個々のコンテンツパッケージに、リポジトリの不変領域（/apps および /libs）または可変領域（/apps または /libs）のいずれか（ただし両方ではない）のコンテンツが含まれている必要があります。例えば、/apps/myco/components/text と /etc/clientlibs/myco の両方を含むパッケージは Cloud Service と互換性がなく、問題が報告されます。

詳しくは、Experience Manager プロジェクト構造を参照してください。

リバースレプリケーションエージェントを使用しない oakpal-reverse-replication

リバースレプリケーションのサポートは、Experience Manager as a Cloud Service のリリースノートで説明しているように、Cloud Service のデプロイメントでは利用できません。

リバースレプリケーションを使用するお客様は、アドビに問い合わせて、代替ソリューションをご利用ください。

プロキシ対応のクライアントライブラリに含まれるリソースは resources という名前のフォルダーに格納する oakpal-resources-proxy

Experience Manager クライアントライブラリには、画像やフォントなどの静的リソースが含まれている場合があります。プリプロセッサーの使用のドキュメントで説明しているように、プロキシ化されたクライアントライブラリを使用する場合、パブリッシュインスタンスで効果的に参照するために、これらの静的リソースを resources という名前の子フォルダーに格納する必要があります。

非準拠コード non-compliant-proxy-enabled

+ apps
  + projectA
    + clientlib
      - allowProxy=true
      + images
        + myimage.jpg

準拠コード compliant-proxy-enabled

+ apps
  + projectA
    + clientlib
      - allowProxy=true
      + resources
        + myimage.jpg

Cloud Service と互換性のないワークフロープロセスの使用 oakpal-usage-cloud-service

Adobe Experience Manager as a Cloud Service でのアセット処理をアセットマイクロサービスに移行するのに伴い、オンプレミスバージョンと AMS バージョンで使用されているいくつかのワークフロープロセスがサポートされなくなりました。これらのワークフローの多くも不要になりました。

Experience Manager as a Cloud Service Assets GitHub リポジトリの移行ツールを使用すると、Experience Manager as a Cloud Service への移行中にワークフローモデルを更新できます。

静的なテンプレートより編集可能なテンプレートの使用を推奨 oakpal-static-template

従来、Experience Manager プロジェクトでは静的テンプレートを使用するのが一般的でしたが、アドビでは、最も柔軟性が高く、静的テンプレートにはない追加機能をサポートしている編集可能なテンプレートをお勧めします。詳しくは、ページテンプレートのドキュメントを参照してください。

静的なテンプレートから編集可能なテンプレートへの移行は、Experience Manager 最新化ツールを使用して、ほとんど自動化することができます。

従来の基盤コンポーネントの使用は推奨されない oakpal-usage-legacy

従来の基盤コンポーネント（/libs/foundation 下のコンポーネントなど）は、一部の Experience Manager リリースでは廃止され、コアコンポーネントが採用されています。使用する方法がオーバーレイであろうと継承であろうと、カスタムコンポーネントの基礎として基盤コンポーネントを使用することは、お勧めしません。対応するコアコンポーネントに変換する必要があります。

Experience Manager 最新化ツールでは、この変換が容易になります。

サポートされている実行モード名と順序のみを使用 oakpal-supported-runmodes

Experience Manager as a Cloud Service では、実行モード名に対して厳密な命名ポリシーを適用し、それらの実行モードに対して厳密な順序を指定します。サポートされている実行モードのリストは、Experience Manager as a Cloud Service へのデプロイのドキュメントで確認でき、このリストからの逸脱は問題として特定されます。

カスタム検索インデックス定義ノードは、/oak:index の直接の子にする必要がある oakpal-custom-search

Experience Manager as a Cloud Service では、カスタム検索インデックス定義（oak:QueryIndexDefinition タイプのノード）が /oak:index の直接の子ノードである必要があります。Experience Manager as a Cloud Service と互換性を持たせるため、他の場所にあるインデックスは移動する必要があります。検索インデックスについて詳しくは、コンテンツの検索とインデックス作成のドキュメントを参照してください。

カスタム検索インデックス定義ノードの compatVersion は 2 にする oakpal-custom-search-compatVersion

Experience Manager as a Cloud Service では、カスタム検索インデックス定義（oak:QueryIndexDefinition タイプのノード）の compatVersion プロパティを 2 に設定する必要があります。Adobe Experience Manager as a Cloud Service は、その他の値をサポートしていません。検索インデックスについて詳しくは、コンテンツの検索とインデックス作成を参照してください。

カスタム検索インデックス定義ノードの子孫ノードのタイプは、nt:unstructured にする oakpal-descendent-nodes

カスタム検索インデックス定義ノードに順序なしの子ノードがある場合、トラブルシューティングしにくい問題が発生するおそれがあります。このような状況を避けるために、oak:QueryIndexDefinition ノードのすべての子孫ノードは、タイプを nt:unstructured にすることをお勧めします。

カスタム検索インデックス定義ノードには、子を持つ indexRules という名前の子ノードを含める oakpal-custom-search-index

適切に定義されたカスタム検索インデックス定義ノードには、indexRules という名前の子ノードが含まれている必要があり、今度は、この子ノードに少なくとも 1 つの子が必要です。詳しくは、Oak ドキュメントを参照してください。

カスタム検索インデックス定義ノードは命名規則に従う oakpal-custom-search-definitions

Experience Manager as a Cloud Service では、コンテンツの検索とインデックス作成のドキュメントで説明されている特定のパターンに従ってカスタム検索インデックス定義（oak:QueryIndexDefinition タイプのノード）に名前を付ける必要があります。

カスタム検索インデックス定義ノードでは lucene 型のインデックスを使用する oakpal-index-type-lucene

Experience Manager as a Cloud Service では、カスタム検索インデックス定義（oak:QueryIndexDefinition タイプのノード）に、値が lucene に設定された type プロパティが必要です。Experience Manager as a Cloud Service に移行する前に、従来のインデックスタイプを使用したインデックス作成を更新する必要があります。詳しくは、コンテンツの検索とインデックス作成を参照してください。

カスタム検索インデックス定義ノードに seed という名前のプロパティを含めない oakpal-property-name-seed

Experience Manager as a Cloud Service では、カスタム検索インデックス定義（ノードのタイプが oak:QueryIndexDefinition）に seed という名前のプロパティを含めることが禁止されています。Experience Manager as a Cloud Service に移行する前に、このプロパティを使用しているインデックスを更新する必要があります。詳しくは、コンテンツの検索とインデックス作成のドキュメントを参照してください。

カスタム検索インデックス定義ノードに reindex というプロパティを含めない oakpal-reindex-property

Experience Manager as a Cloud Service では、カスタム検索インデックス定義（ノードのタイプが oak:QueryIndexDefinition）に reindex という名前のプロパティを含めることが禁止されています。Experience Manager as a
Cloud Service に移行する前に、このプロパティを使用しているインデックスを更新する必要があります。詳しくは、コンテンツの検索とインデックス作成のドキュメントを参照してください。

カスタム DAM Asset Lucene ノードで queryPaths を指定することはできません oakpal-damAssetLucene-queryPaths

非準拠コード non-compliant-code-damAssetLucene-queryPaths

+ oak:index
    + damAssetLucene-1-custom-1
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: [/content/dam]
      - queryPaths: [/content/dam]
      - type: lucene
      + tika
        + config.xml

準拠コード compliant-code-damAssetLucene-queryPaths

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: [/content/dam]
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

カスタム検索のインデックス定義に compatVersion が含まれる場合は、2 に設定する必要があります oakpal-compatVersion

includedPaths を指定するインデックスノードでは、同じ値を持つ queryPaths も指定する必要があります oakpal-included-paths-without-query-paths

カスタムインデックスの場合は、includedPaths と queryPaths を同じ値で設定します。いずれかを指定した場合は、もう 1 つが一致する必要があります。ただし、damAssetLucene のインデックスには特別なケースがあります（カスタムバージョンを含む）。この場合は、includedPaths のみを指定します。

汎用ノードタイプの nodeScopeIndex を指定するインデックスノードでも includedPaths と queryPaths を指定する必要があります oakpal-full-text-on-generic-node-type

nt:unstructured または nt:base のような「汎用」ノードタイプで nodeScopeIndex プロパティを設定する場合、includedPaths および queryPaths プロパティも指定する必要があります。
ノードタイプ nt:base は「汎用」と見なすことができます。これは、すべてのノードタイプがそのタイプを継承するからです。したがって、nt:base に nodeScopeIndex を設定すると、リポジトリ内のすべてのノードのインデックスが作成されます。同様に、このタイプのリポジトリには多数のノードがあるので、nt:unstructured も「汎用」と見なされます。

非準拠コード non-compliant-code-full-text-on-generic-node-type

+ oak:index/acme.someIndex-custom-1
  - async: [async, nrt]
  - evaluatePathRestrictions: true
  - tags: [visualSimilaritySearch]
  - type: lucene
    + indexRules
      - jcr:primaryType: nt:unstructured
      + nt:base
        - jcr:primaryType: nt:unstructured
        + properties
          + acme.someIndex-custom-1
            - nodeScopeIndex: true

準拠コード compliant-code-full-text-on-generic-node-type

+ oak:index/acme.someIndex-custom-1
  - async: [async, nrt]
  - evaluatePathRestrictions: true
  - tags: [visualSimilaritySearch]
  - type: lucene
  - includedPaths: ["/content/dam/"]
  - queryPaths: ["/content/dam/"]
    + indexRules
      - jcr:primaryType: nt:unstructured
      + nt:base
        - jcr:primaryType: nt:unstructured
        + properties
          + acme.someIndex-custom-1
            - nodeScopeIndex: true

クエリエンジンの queryLimitReads プロパティは上書きしないでください oakpal-query-limit-reads

デフォルト値を上書きすると、特にコンテンツが追加された場合に、ページの読み取りが遅くなる可能性があります。

同じインデックスの複数のアクティブバージョン oakpal-multiple-active-versions

非準拠コード non-compliant-code-multiple-active-versions

+ oak:index
  + damAssetLucene-1-custom-1
    ...
  + damAssetLucene-1-custom-2
    ...
  + damAssetLucene-1-custom-3
    ...

準拠コード compliant-code-multiple-active-versions

+ damAssetLucene-1-custom-3
    ...

完全なカスタムインデックス定義の名前は、公式のガイドラインに従う必要があります oakpal-fully-custom-index-name

完全なカスタムインデックス名に必要なパターンは [prefix].[indexName]-custom-[version] です。詳しくは、コンテンツの検索とインデックス作成のドキュメントを参照してください。

同じインデックス定義内で異なる分析値を持つ同じプロパティ oakpal-same-property-different-analyzed-values

非準拠コード non-compliant-code-same-property-different-analyzed-values

+ indexRules
  + dam:Asset
    + properties
      + status
        - name: status
        - analyzed: true
  + dam:cfVariationNode
    + properties
      + status
        - name: status

準拠コード compliant-code-same-property-different-analyzed-values

例：

+ indexRules
  + dam:Asset
    + properties
      + status
        - name: status
        - analyzed: true
  + dam:cfVariationNode
    + properties
      + status
        - name: status
        - analyzed: true

例：

+ indexRules
  + dam:Asset
    + properties
      + status
        - name: status
  + dam:cfVariationNode
    + properties
      + status
        - name: status
        - analyzed: true

分析対象のプロパティが明示的に設定されていない場合、そのデフォルト値は false になります。

タグプロパティ tags-property

個別のインデックスでは、タグプロパティとその現在の値を必ず保持してください。タグプロパティに新しい値を追加することもできますが、既存の値を削除（またはプロパティを完全に削除）すると、予期しない結果が生じる場合があります。

インデックス定義ノードを UI コンテンツパッケージにデプロイしない oakpal-ui-content-package

AEM Cloud Service では、UI コンテンツパッケージでカスタム検索インデックス定義（タイプ oak:QueryIndexDefinition のノード）をデプロイすることは禁止されています。

damAssetLucene タイプのカスタムフルテキストインデックス定義には、「damAssetLucene」というプレフィックスを正しく付ける oakpal-dam-asset-lucene

AEM Cloud Service では、damAssetLucene タイプのカスタムフルテキストインデックス定義に damAssetLucene 以外のプレフィックスを付けることが禁止されています。

インデックス定義ノードに同じ名前のプロパティを含めない oakpal-index-property-name

AEM Cloud Service では、カスタム検索インデックス定義（つまり、タイプ oak:QueryIndexDefinition のノード）に同じ名前のプロパティを含めることが禁止されています。

特定の標準インデックス定義のカスタマイズは禁止されている oakpal-customizing-ootb-index

AEM Cloud Service では、次の OOTB インデックスの許可されていない変更が禁止されています。

アナライザーの tokenizer の設定は、「tokenizer」という名前で作成する oakpal-tokenizer

AEM Cloud Service では、アナライザーで誤った名前のトークナイザーを作成することが禁止されています。トークナイザーは、常に tokenizer として定義する必要があります。

インデックス作成定義の設定にスペースを含めることはできない oakpal-indexing-definitions-spaces

AEM Cloud Service では、プロパティにスペースを使用したインデックス作成定義の作成が禁止されています。