org.springframework.data.rest.core.mapping

Interface ResourceMetadata

All Superinterfaces:

CollectionResourceMapping, ResourceMapping

public interface ResourceMetadata
extends CollectionResourceMapping

Interface for metadata of resources exposed through the system.

Author:

Oliver Gierke

Method Summary

Modifier and Type	Method and Description
Class<?>	getDomainType() Returns the domain type that is exposed through the resource.
ResourceMapping	getMappingFor(PersistentProperty<?> property) Returns the ResourceMapping for the given PersistentProperty or null if not managed.
PropertyAwareResourceMapping	getProperty(String mappedPath) Returns the PropertyAwareResourceMapping for the given mapped path.
SearchResourceMappings	getSearchResourceMappings() Returns the SearchResourceMappings, i.e. the mappings for the search resource exposed for the current resource.
SupportedHttpMethods	getSupportedHttpMethods() Returns the supported HttpMethods for the given ResourceType.
boolean	isExported(PersistentProperty<?> property) Returns whether the given PersistentProperty is a managed resource and in fact exported.

Methods inherited from interface org.springframework.data.rest.core.mapping.CollectionResourceMapping

getExcerptProjection, getItemResourceDescription, getItemResourceRel

Methods inherited from interface org.springframework.data.rest.core.mapping.ResourceMapping

getDescription, getPath, getRel, isExported, isPagingResource

Method Detail

getDomainType

Class<?> getDomainType()

Returns the domain type that is exposed through the resource.

Returns:

isExported

boolean isExported(PersistentProperty<?> property)

Returns whether the given PersistentProperty is a managed resource and in fact exported.

Parameters:

property - must not be null.

Returns:

getProperty

PropertyAwareResourceMapping getProperty(String mappedPath)

Returns the PropertyAwareResourceMapping for the given mapped path.

Parameters:

mappedPath - must not be null or empty.

Returns:

the PropertyAwareResourceMapping for the given path or null if none found.

getMappingFor

ResourceMapping getMappingFor(PersistentProperty<?> property)

Returns the ResourceMapping for the given PersistentProperty or null if not managed.

Parameters:

property - must not be null.

Returns:

getSearchResourceMappings

SearchResourceMappings getSearchResourceMappings()

Returns the SearchResourceMappings, i.e. the mappings for the search resource exposed for the current resource.

Returns:

getSupportedHttpMethods

SupportedHttpMethods getSupportedHttpMethods()

Returns the supported HttpMethods for the given ResourceType.

Parameters:

resourcType - must not be null.

Returns: