org.springframework.data.rest.core.annotation

Annotation Type RepositoryRestResource

@Target(value=TYPE)
@Retention(value=RUNTIME)
@Inherited
public @interface RepositoryRestResource

Annotate a Repository with this to customize export mapping and rels.

Author:

Oliver Gierke

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Description	collectionResourceDescription The description of the collection resource.
String	collectionResourceRel The rel value to use when generating links to the collection resource.
boolean	exported Flag indicating whether this resource is exported at all.
Description	itemResourceDescription The description of the item resource.
String	itemResourceRel The rel value to use when generating links to the item resource.
String	path The path segment under which this resource is to be exported.

Element Detail

exported

public abstract boolean exported

Flag indicating whether this resource is exported at all.

Returns:

true if the resource is to be exported, false otherwise.

Default:

true

path

public abstract String path

The path segment under which this resource is to be exported.

Returns:

A valid path segment.

Default:

""

collectionResourceRel

public abstract String collectionResourceRel

The rel value to use when generating links to the collection resource.

Returns:

A valid rel value.

Default:

""

collectionResourceDescription

public abstract Description collectionResourceDescription

The description of the collection resource.

Returns:

Default:

@org.springframework.data.rest.core.annotation.Description("")

itemResourceRel

public abstract String itemResourceRel

The rel value to use when generating links to the item resource.

Returns:

A valid rel value.

Default:

""

itemResourceDescription

public abstract Description itemResourceDescription

The description of the item resource.

Returns:

Default:

@org.springframework.data.rest.core.annotation.Description("")