クラス ControllerEntityLinks
java.lang.ObjectSE
org.springframework.hateoas.server.core.AbstractEntityLinks
org.springframework.hateoas.server.core.ControllerEntityLinks
- 実装されたすべてのインターフェース:
EntityLinks
,org.springframework.plugin.core.Plugin<ClassSE<?>>
特定の URI マッピング構造を想定する
EntityLinks
実装:- アノテーション付きコントローラーがコレクションとアイテムのリソースを公開することを宣言するクラスレベルの
ExposesResourceFor
アノテーション。 - コレクションリソースのベース URI を形成する
RequestMapping
アノテーション。 - 少なくとも 1 つの HTTP メソッドを実際に処理するためのマッピングアノテーションを含むコントローラーメソッド。
- 項目リソースを識別するためにパス変数を使用して従属リソースをマップするコントローラーメソッド。
@Controller @ExposesResourceFor(Order.class) @RequestMapping("/orders") class OrderController { @GetMapping ResponseEntity orders(…) { … } @GetMapping("/{id}") ResponseEntity order(@PathVariable("id") … ) { … } }
- 作成者:
- Oliver Gierke
コンストラクターのサマリー
コンストラクターコンストラクター説明ControllerEntityLinks
(IterableSE<? extends ClassSE<?>> controllerTypes, LinkBuilderFactory<? extends LinkBuilder> linkBuilderFactory) 指定されたアノテーションの構成済みクラスをインスペクションする新しいControllerEntityLinks
を作成します。メソッドのサマリー
修飾子と型メソッド説明指定されたエンティティ型を管理するコントローラーへのリンクを作成できるLinkBuilder
を返します。指定されたエンティティ型を管理するコントローラーへのリンクを作成できるLinkBuilder
を返し、指定されたパラメーターをバッキングコントローラーがマップされている URI テンプレートに展開します。linkToCollectionResource
(ClassSE<?> entity) 指定された型のコレクションリソースを指すLink
を作成します。linkToItemResource
(ClassSE<?> entity, ObjectSE id) 指定されたエンティティ型と ID をサポートするアイテムリソースを指すLink
を作成します。boolean
クラス org.springframework.hateoas.server.core.AbstractEntityLinks から継承されたメソッド
linkForItemResource
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.hateoas.server.EntityLinks から継承されたメソッド
forType, forType, linkForItemResource, linkToItemResource
コンストラクターの詳細
ControllerEntityLinks
public ControllerEntityLinks(IterableSE<? extends ClassSE<?>> controllerTypes, LinkBuilderFactory<? extends LinkBuilder> linkBuilderFactory) 指定されたアノテーションの構成済みクラスをインスペクションする新しいControllerEntityLinks
を作成します。- パラメーター:
controllerTypes
- インスペクションするコントローラークラスは、null であってはなりません。linkBuilderFactory
- リンクの作成に使用するLinkBuilder
は null であってはなりません。
メソッドの詳細
linkFor
インターフェースからコピーされた説明:EntityLinks
指定されたエンティティ型を管理するコントローラーへのリンクを作成できるLinkBuilder
を返します。コントローラーが完全に展開された URI テンプレートにマップされていることを期待します (つまり、パス変数が使用されていません)。- パラメーター:
entity
- 指すエンティティ型。null であってはなりません。- 戻り値:
- コレクションリソースを指す
LinkBuilder
。null になることはありません。
linkFor
インターフェースからコピーされた説明:EntityLinks
指定されたエンティティ型を管理するコントローラーへのリンクを作成できるLinkBuilder
を返し、指定されたパラメーターをバッキングコントローラーがマップされている URI テンプレートに展開します。- パラメーター:
entity
- 指すエンティティ型。null であってはなりません。- 戻り値:
- コレクションリソースを指す
LinkBuilder
。
linkToCollectionResource
インターフェースからコピーされた説明:EntityLinks
指定された型のコレクションリソースを指すLink
を作成します。リンクの関係型は実装クラスによって決定され、デフォルトでIanaLinkRelations.SELF
に設定する必要があります。- パラメーター:
entity
- 指すエンティティ型。null であってはなりません。- 戻り値:
- 特定のエンティティ用に公開されたコレクションリソースを指す
Link
。null になることはありません。
linkToItemResource
インターフェースからコピーされた説明:EntityLinks
指定されたエンティティ型と ID をサポートするアイテムリソースを指すLink
を作成します。リンクの関係型は実装クラスによって決定され、デフォルトでIanaLinkRelations.SELF
に設定する必要があります。- パラメーター:
entity
- 指すエンティティ型。null であってはなりません。id
- 指定された型のエンティティの識別子- 戻り値:
- 指定された型と ID を持つエンティティ用に公開されたリソースを指す
Link
。null になることはありません。
supports