インターフェース SanitizingFunction

メソッドの詳細

• apply

  SanitizableData apply(SanitizableData data)

  指定されたデータにサニタイズ機能を適用します。

  パラメーター:

  data - 消毒するデータ

  戻り値:

  サニタイズされたデータまたは元のインスタンスはサニタイズが適用されていません

• filter

  default PredicateSE<SanitizableData> filter()

  サニタイズ機能が適用されるかどうかを決定するオプションのフィルターを返します。

  戻り値:

  関数をフィルタリングするために使用される述語、またはフィルターが宣言されていない場合は null 

  導入:

  3.5.0

  関連事項:

  • applyUnlessFiltered(SanitizableData)

• applyUnlessFiltered

  default SanitizableData applyUnlessFiltered(SanitizableData data)

  フィルターを通過するかフィルターがない場合は、除菌機能を適用します。

  パラメーター:

  data - 消毒するデータ

  戻り値:

  サニタイズされたデータまたは元のインスタンスはサニタイズが適用されていません

  導入:

  3.5.0

• ifLikelySensitive

  default SanitizingFunction ifLikelySensitive()

  データに機密値が含まれている可能性がある場合にも適用されるフィルターを備えた新しい関数を返します。このメソッドは、便利なサニタイズ関数の構築に役立ちますが、すべての機密データを取得できるとは限らないため、特定の環境で結果をテストする際には注意が必要です。

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifLikelyCredential

  default SanitizingFunction ifLikelyCredential()

  データに認証情報が含まれている可能性がある場合にも適用されるフィルターを備えた新しい関数を返します。このメソッドは、有用なサニタイズ関数の構築に役立ちますが、すべての機密データを検出できるとは限らないため、特定の環境で結果をテストする際には注意が必要です。

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifLikelyUri

  default SanitizingFunction ifLikelyUri()

  データに URI が含まれる可能性がある場合にも適用されるフィルターを備えた新しい関数を返します。このメソッドは、有用なサニタイズ関数の構築に役立ちますが、すべての機密データを検出できるとは限りません。そのため、特定の環境で結果をテストする際には注意が必要です。

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifLikelySensitiveProperty

  default SanitizingFunction ifLikelySensitiveProperty()

  データに機密性の高いプロパティ値が含まれている可能性がある場合にも適用されるフィルターを備えた新しい関数を返します。このメソッドは有用なサニタイズ関数の構築に役立ちますが、すべての機密データを検出できるとは限らないため、特定の環境で結果をテストする際には注意が必要です。

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifVcapServices

  default SanitizingFunction ifVcapServices()

  データが VCAP サービス用である場合にも適用されるフィルターを備えた新しい関数を返します。

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifKeyEquals

  default SanitizingFunction ifKeyEquals(StringSE... values)

  データキーが指定された値のいずれかと等しい場合にも適用されるフィルターを持つ新しい関数を返します (大文字と小文字は区別されません)。

  パラメーター:

  values - キーに等しい大文字と小文字を区別しない値

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifKeyEndsWith

  default SanitizingFunction ifKeyEndsWith(StringSE... suffixes)

  データキーが指定された値のいずれかで終わる場合にも適用されるフィルターを持つ新しい関数を返します (大文字と小文字は区別されません)。

  パラメーター:

  suffixes - キーの末尾に大文字と小文字を区別しない接尾辞を付けることができる

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifKeyContains

  default SanitizingFunction ifKeyContains(StringSE... values)

  データキーに指定された値のいずれかが含まれている場合にも適用されるフィルターを持つ新しい関数を返します (大文字と小文字は区別されません)。

  パラメーター:

  values - キーに含めることができる大文字と小文字を区別しない値

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifKeyMatchesIgnoringCase

  default SanitizingFunction ifKeyMatchesIgnoringCase(BiPredicateSE<StringSE,StringSE> predicate, StringSE... values)

  データキーと値のいずれかが指定された述語に一致する場合にも適用されるフィルターを持つ新しい関数を返します。この述語は小文字の値を持つ場合にのみ呼び出されます。

  パラメーター:

  predicate - キーと値を比較するために使用する述語。キーは最初の引数、値は 2 番目の引数です。どちらも小文字に変換されます。

  values - キーが一致する大文字と小文字を区別しない値

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifKeyMatches

  default SanitizingFunction ifKeyMatches(StringSE... regexes)

  データキーが指定された正規表現パターンのいずれかに一致する場合にも適用されるフィルターを持つ新しい関数を返します (大文字と小文字は区別されません)。

  パラメーター:

  regexes - キーが一致する大文字と小文字を区別しない正規表現

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifKeyMatches

  default SanitizingFunction ifKeyMatches(PatternSE... patterns)

  データキーが指定されたパターンのいずれかに一致する場合にも適用されるフィルターを持つ新しい関数を返します。

  パラメーター:

  patterns - キーが一致できるパターン

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifKeyMatches

  default SanitizingFunction ifKeyMatches(ListSE<PredicateSE<StringSE>> predicates)

  データキーが指定された述語のいずれかと一致する場合にも適用されるフィルターを持つ新しい関数を返します。

  パラメーター:

  predicates - キーが一致する述語

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifKeyMatches

  default SanitizingFunction ifKeyMatches(PredicateSE<StringSE> predicate)

  データキーが指定された述語のいずれかと一致する場合にも適用されるフィルターを持つ新しい関数を返します。

  パラメーター:

  predicate - キーが一致する述語

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifValueStringMatches

  default SanitizingFunction ifValueStringMatches(StringSE... regexes)

  データ文字列値が指定された正規表現パターンのいずれかに一致する場合にも適用されるフィルターを持つ新しい関数を返します (大文字と小文字は区別されません)。

  パラメーター:

  regexes - 値の文字列が一致する大文字と小文字を区別しない正規表現

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifValueStringMatches

  default SanitizingFunction ifValueStringMatches(PatternSE... patterns)

  データ文字列値が指定されたパターンのいずれかに一致する場合にも適用されるフィルターを持つ新しい関数を返します。

  パラメーター:

  patterns - 値文字列が一致する可能性のあるパターン

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifValueStringMatches

  default SanitizingFunction ifValueStringMatches(ListSE<PredicateSE<StringSE>> predicates)

  データ文字列値が指定された述語のいずれかに一致する場合にも適用されるフィルターを持つ新しい関数を返します。

  パラメーター:

  predicates - 値文字列が一致する可能性のある述語

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifValueMatches

  default SanitizingFunction ifValueMatches(ListSE<PredicateSE<ObjectSE>> predicates)

  データ値が指定された述語のいずれかに一致する場合にも適用されるフィルターを持つ新しい関数を返します。

  パラメーター:

  predicates - 値が一致する述語

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifValueStringMatches

  default SanitizingFunction ifValueStringMatches(PredicateSE<StringSE> predicate)

  データ文字列値が指定された述語と一致する場合にも適用されるフィルターを持つ新しい関数を返します。

  パラメーター:

  predicate - 値文字列が一致する述語

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifValueMatches

  default SanitizingFunction ifValueMatches(PredicateSE<ObjectSE> predicate)

  データ値が指定された述語と一致する場合にも適用されるフィルターを持つ新しい関数を返します。

  パラメーター:

  predicate - 値が一致する述語

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifMatches

  default SanitizingFunction ifMatches(ListSE<PredicateSE<SanitizableData>> predicates)

  データが指定された述語のいずれかに一致する場合にも適用されるフィルターを持つ新しい関数を返します。

  パラメーター:

  predicates - データが一致できる述語

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• ifMatches

  default SanitizingFunction ifMatches(PredicateSE<SanitizableData> predicate)

  データが指定された述語と一致する場合にも適用されるフィルターを持つ新しい関数を返します。

  パラメーター:

  predicate - データが一致できる述語

  戻り値:

  アップデートされた filter() による新しい消毒機能

  導入:

  3.5.0

  関連事項:

  • filter()
  • sanitizeValue()

• sanitizeValue

  static SanitizingFunction sanitizeValue()

  値をサニタイズする SanitizingFunction を返すファクトリメソッド。このメソッドは、1 つ以上の if... メソッドと連鎖されることが多いです。例:

   return SanitizingFunction.sanitizeValue()
          .ifKeyContains("password", "secret")
          .ifValueStringMatches("^gh._[a-zA-Z0-9]{36}$");
   

  戻り値:

  値をサニタイズする SanitizingFunction。

• of

  static SanitizingFunction of(SanitizingFunction sanitizingFunction)

  sanitizingFunction をラムダとして扱う際に使用できるヘルパーメソッド。例:

   SanitizingFunction.of((data) -> data.withValue("----")).ifKeyContains("password");
   

  パラメーター:

  sanitizingFunction - サニタイズ関数ラムダ

  戻り値:

  さらなるメソッド呼び出しのための SanitizingFunction

  導入:

  3.5.0