public class ResourceLookupDictionary extends java.lang.Object implements ResourceLocator
COLLECTION_RESOURCE, ENTITY_ID, RELATIONSHIP_ID, RELATIONSHIP_RESOURCE
Constructor and Description |
---|
ResourceLookupDictionary() |
Modifier and Type | Method and Description |
---|---|
ResourceDictionary |
getDictionary() |
java.util.Map |
locateEmbeddedResources(Api api,
java.util.Map embeddedKeys)
For a given Map finds any resources that should be embedded inside a class.
|
ResourceWithMetadata |
locateEntityResource(Api api,
java.lang.String entityResource,
org.springframework.http.HttpMethod httpMethod)
Finds an Entity Resource and returns it in ResourceWithMetadata wrapper.
|
java.util.Map |
locateRelationResource(Api api,
java.lang.String entityKey,
java.util.Collection relationshipKeys,
org.springframework.http.HttpMethod httpMethod)
Finds multiple relationship Resources and returns them as a Map of ResourceWithMetadata.
|
ResourceWithMetadata |
locateRelationResource(Api api,
java.lang.String entityResource,
java.lang.String relationResource,
org.springframework.http.HttpMethod httpMethod)
Finds an Relationship Resource and returns it in ResourceWithMetadata wrapper.
|
ResourceWithMetadata |
locateResource(Api api,
java.util.Map templateVars,
org.springframework.http.HttpMethod httpMethod)
Locates a resource by URI path and wraps it in an invoker
This will probably get refactored later when we work out what we
are doing with the discoverability model.
|
void |
setDictionary(ResourceDictionary dictionary) |
public ResourceWithMetadata locateEntityResource(Api api, java.lang.String entityResource, org.springframework.http.HttpMethod httpMethod) throws InvalidArgumentException, UnsupportedResourceOperationException
ResourceLocator
locateEntityResource
in interface ResourceLocator
api
- - The API being used.entityResource
- - The entity resource name - this is the "name" property on the @EntityResource annotation.httpMethod
- - A permitted HttpMethodInvalidArgumentException
- - thrown if either the api or resourceName's are invalid. ie. A resource doesn't exist.UnsupportedResourceOperationException
- - throw if the resource does not support the specified HttpMethod.public ResourceWithMetadata locateRelationResource(Api api, java.lang.String entityResource, java.lang.String relationResource, org.springframework.http.HttpMethod httpMethod) throws InvalidArgumentException, UnsupportedResourceOperationException
ResourceLocator
locateRelationResource
in interface ResourceLocator
api
- - The API being used.entityResource
- - The entity resource name - this is the "entityResourceName" property on the @RelationshipResource annotation.relationResource
- - The relationship resource name - this is the "name" property on the @RelationshipResource annotation.httpMethod
- - A permitted HttpMethodInvalidArgumentException
- - thrown if either the api or resourceName's are invalid. ie. A resource doesn't exist.UnsupportedResourceOperationException
- - throw if the resource does not support the specified HttpMethod.public ResourceWithMetadata locateResource(Api api, java.util.Map templateVars, org.springframework.http.HttpMethod httpMethod)
locateResource
in interface ResourceLocator
api
- - The API being used.templateVars
- A map of variables representing the requesthttpMethod
- - A permitted HttpMethodpublic java.util.Map locateEmbeddedResources(Api api, java.util.Map embeddedKeys)
ResourceLocator
locateEmbeddedResources
in interface ResourceLocator
api
- - The API being used.embeddedKeys
- - Likely to be the result of a call to ResourceInspector.findEmbeddedResources()public java.util.Map locateRelationResource(Api api, java.lang.String entityKey, java.util.Collection relationshipKeys, org.springframework.http.HttpMethod httpMethod)
ResourceLocator
locateRelationResource
in interface ResourceLocator
api
- - The API being used.entityKey
- - this is the "entityResourceName" property on the @RelationshipResource annotation.relationshipKeys
- - The relationship resource names - this is the "name" property on the @RelationshipResource annotation.httpMethod
- - A permitted HttpMethodpublic void setDictionary(ResourceDictionary dictionary)
dictionary
- the dictionary to setpublic ResourceDictionary getDictionary()
Copyright © 2005 - 2013 Alfresco Software, Inc. All Rights Reserved.