クラス BaseHttpInboundEndpoint

方法の詳細

• setPayloadExpression

  public void setPayloadExpression(Expression payloadExpression)

  メッセージペイロードを生成するために評価する SpEL 式を指定します。EvaluationContext には、ルートオブジェクトとして HttpEntity インスタンスが設定され、変数を含めることができます。

  • #pathVariables
  • #requestParams
  • #requestAttributes
  • #requestHeaders
  • #matrixVariables
  • #cookies

  パラメーター:

  payloadExpression - ペイロード式。

• setHeaderExpressions

  public void setHeaderExpressions(MapSE<StringSE, Expression> headerExpressions)

  Message ヘッダーを生成するために評価する SpEL 式のマップを指定します。マップ内のキーはヘッダー名として使用されます。式を評価する場合、EvaluationContext にはルートオブジェクトとして HttpEntity インスタンスが設定され、変数を含めることができます。

  • #pathVariables
  • #requestParams
  • #requestAttributes
  • #requestHeaders
  • #matrixVariables
  • #cookies

  パラメーター:

  headerExpressions - ヘッダー式。

• setRequestMapping

  public void setRequestMapping(RequestMapping requestMapping)

  このエンドポイントに柔軟な RESTFul マッピングを指定できるようにする RequestMapping を設定します。

  パラメーター:

  requestMapping - リクエストのマッピング。

• getRequestMapping

  public final RequestMapping getRequestMapping()

• setCrossOrigin

  public void setCrossOrigin(CrossOrigin crossOrigin)

  このエンドポイントのクロスオリジンリクエストを許可するように CrossOrigin を設定します。

  パラメーター:

  crossOrigin - CrossOrigin 構成。

  導入:

  4.2

• getCrossOrigin

  public @Nullable CrossOrigin getCrossOrigin()

• getPayloadExpression

  protected @Nullable Expression getPayloadExpression()

• getHeaderExpressions

  protected @Nullable MapSE<StringSE, Expression> getHeaderExpressions()

• isExpectReply

  protected boolean isExpectReply()

  戻り値:

  返信を期待するかどうか。

• setHeaderMapper

  public void setHeaderMapper(HeaderMapper<HttpHeaders> headerMapper)

  HTTP ヘッダーと MessageHeaders の間のマッピング時に使用する HeaderMapper を設定します。

  パラメーター:

  headerMapper - ヘッダーマッパー。

• getHeaderMapper

  protected HeaderMapper<HttpHeaders> getHeaderMapper()

• setRequestPayloadTypeClass

  public void setRequestPayloadTypeClass(ClassSE<?> requestPayloadType)

  受信 HTTP リクエストのコンテンツがコンバーター / エンコーダによって読み取られる際に生成されるペイロードの型を指定します。デフォルトではこの値は null です。つまり、実行時に "text" Content-Type は String になり、それ以外の場合はデフォルトで byte[].class になります。

  パラメーター:

  requestPayloadType - ペイロード型。

• setRequestPayloadType

  public void setRequestPayloadType(ResolvableType requestPayloadType)

  受信 HTTP リクエストのコンテンツがコンバーター / エンコーダによって読み取られる際に生成されるペイロードの型を指定します。デフォルトではこの値は null です。つまり、実行時に "text" Content-Type は String になり、それ以外の場合はデフォルトで byte[].class になります。

  パラメーター:

  requestPayloadType - ペイロード型。

• getRequestPayloadType

  protected @Nullable ResolvableType getRequestPayloadType()

• setExtractReplyPayload

  public void setExtractReplyPayload(boolean extractReplyPayload)

  レスポンスメッセージのペイロードのみをレスポンスで渡すかどうかを指定します。これが "false" に設定されている場合、メッセージ全体がレスポンスの生成に使用されます。デフォルトは "true" です。

  パラメーター:

  extractReplyPayload - 応答ペイロードを抽出する場合は true。

• getExtractReplyPayload

  protected boolean getExtractReplyPayload()

• setStatusCodeExpressionString

  public void setStatusCodeExpressionString(StringSE statusCodeExpression)

  Expression を指定して、レスポンスのステータスコードを解決し、タイムアウトのデフォルトの "200 OK" または "500 Internal Server Error" をオーバーライドします。

  パラメーター:

  statusCodeExpression - ステータスコードの式。

  導入:

  5.0

  関連事項:

  • setStatusCodeExpression(Expression)

• setStatusCodeExpression

  public void setStatusCodeExpression(Expression statusCodeExpression)

  Expression を指定して、レスポンスのステータスコードを解決し、タイムアウトのデフォルトの "200 OK" または "500 Internal Server Error" をオーバーライドします。

  statusCodeExpression は、一方向 <http:inbound-channel-adapter/> の場合、またはゲートウェイの応答（タイムアウト）が受信されない場合にのみ適用されます。<http:inbound-gateway/> （または expectReply が true の場合）は、HttpHeaders.STATUS_CODE 応答 Message ヘッダーから HttpStatus を解決します。

  パラメーター:

  statusCodeExpression - ステータスコードの式。

  導入:

  4.1

  関連事項:

  • MessagingGatewaySupport.setReplyTimeout(long)
  • HttpRequestHandlingEndpointSupport(boolean)

• getStatusCodeExpression

  protected @Nullable Expression getStatusCodeExpression()

• setValidator

  public void setValidator(Validator validator)

  Validator を指定して、リクエストから変換されたペイロードを検証します。

  パラメーター:

  validator - 使用する Validator。

  導入:

  5.2

• getValidator

  protected @Nullable Validator getValidator()

• onInit

  protected void onInit()

  クラスからコピーされた説明: IntegrationObjectSupport

  サブクラスは、初期化ロジック用にこれを実装できます。

  オーバーライド:

  クラス MessagingGatewaySupport の onInit 

• evaluateHttpStatus

  protected @Nullable HttpStatus evaluateHttpStatus(HttpEntity<?> httpEntity)

• resolveHttpStatusFromHeaders

  protected @Nullable HttpStatus resolveHttpStatusFromHeaders(MessageHeaders headers)

• createEvaluationContext

  protected StandardEvaluationContext createEvaluationContext()

• beforeShutdown

  public int beforeShutdown()

  インターフェースからコピーされた説明: OrderlyShutdownCapable

  シャットダウンが始まる前に呼び出されます。実装は、新しいメッセージの受け入れを停止する必要があります。オプションで、処理中のアクティブなメッセージの数を返すことができます。

  次で指定:

  インターフェース OrderlyShutdownCapable 内の beforeShutdown 

  戻り値:

  使用可能な場合、アクティブなメッセージの数。

• afterShutdown

  public int afterShutdown()

  インターフェースからコピーされた説明: OrderlyShutdownCapable

  スケジューラー、エグゼキューターなどの通常のシャットダウンの後、シャットダウン遅延が経過した後、残りのアクティブなスケジューラー / エグゼキュータースレッドの強制シャットダウンの前に呼び出されます。オプションで、まだ処理中のアクティブなメッセージの数を返すことができます。

  次で指定:

  インターフェース OrderlyShutdownCapable 内の afterShutdown 

  戻り値:

  使用可能な場合、アクティブなメッセージの数。

• getComponentType

  public StringSE getComponentType()

  次で指定:

  インターフェース NamedComponent 内の getComponentType 

  オーバーライド:

  クラス MessagingGatewaySupport の getComponentType 

• getIntegrationPatternType

  public IntegrationPatternType getIntegrationPatternType()

  インターフェースからコピーされた説明: IntegrationPattern

  このコンポーネントが実装するパターン型を返します。

  次で指定:

  インターフェース IntegrationPattern 内の getIntegrationPatternType 

  オーバーライド:

  クラス MessagingGatewaySupport の getIntegrationPatternType 

  戻り値:

  このコンポーネントが実装する IntegrationPatternType

• validate

  protected void validate(ObjectSE value)

• isReadable

  protected static boolean isReadable(@Nullable HttpMethod httpMethod)

  リクエストに読み取り可能な本文があるかどうかを確認します（GET、HEAD、OPTIONS リクエストではありません）。

  パラメーター:

  httpMethod - チェックする HTTP メソッド

  戻り値:

  HTTP リクエストに本文を含めることができる場合は true または false