org.springframework.data.rest.webmvc

Class RootResourceInformation

java.lang.Object

org.springframework.data.rest.webmvc.RootResourceInformation

public class RootResourceInformation
extends Object

Meta-information about the root repository resource.

Author:

Jon Brisbin, Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
RootResourceInformation(ResourceMetadata metadata, PersistentEntity<?,?> entity, RepositoryInvoker invoker)

Method Summary

Methods

Modifier and Type	Method and Description
Class<?>	getDomainType()
RepositoryInvoker	getInvoker()
PersistentEntity<?,?>	getPersistentEntity()
ResourceMetadata	getResourceMetadata()
SearchResourceMappings	getSearchMappings()
Collection<HttpMethod>	getSupportedMethods(ResourceType resourcType) Returns the supported HttpMethods for the given ResourceType.
boolean	supports(HttpMethod httpMethod, ResourceType resourceType) Returns whether the given HttpMethod is supported for the given ResourceType.
void	verifySupportedMethod(HttpMethod httpMethod, ResourceType resourceType) Verifies that the given HttpMethod is supported for the given ResourceType.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RootResourceInformation

public RootResourceInformation(ResourceMetadata metadata,
                       PersistentEntity<?,?> entity,
                       RepositoryInvoker invoker)

Method Detail

getDomainType

public Class<?> getDomainType()

getResourceMetadata

public ResourceMetadata getResourceMetadata()

getSearchMappings

public SearchResourceMappings getSearchMappings()

getInvoker

public RepositoryInvoker getInvoker()

getPersistentEntity

public PersistentEntity<?,?> getPersistentEntity()

getSupportedMethods

public Collection<HttpMethod> getSupportedMethods(ResourceType resourcType)

Returns the supported HttpMethods for the given ResourceType.

Parameters:

resourcType - must not be null.

Returns:

supports

public boolean supports(HttpMethod httpMethod,
               ResourceType resourceType)

Returns whether the given HttpMethod is supported for the given ResourceType.

Parameters:

httpMethod - must not be null.

resourceType - must not be null.

Returns:

verifySupportedMethod

public void verifySupportedMethod(HttpMethod httpMethod,
                         ResourceType resourceType)
                           throws HttpRequestMethodNotSupportedException

Verifies that the given HttpMethod is supported for the given ResourceType.

Parameters:

httpMethod - must not be null.

resourceType - must not be null.

Throws:

HttpRequestMethodNotSupportedException - if the ResourceType does not support the given HttpMethod. Will contain all supported methods as indicators for clients.