public interface ResourceLocator
Modifier and Type | Field and Description |
---|---|
static String |
COLLECTION_RESOURCE |
static String |
ENTITY_ID |
static String |
PROPERTY |
static String |
RELATIONSHIP_ID |
static String |
RELATIONSHIP_RESOURCE |
Modifier and Type | Method and Description |
---|---|
Map<String,ResourceWithMetadata> |
locateEmbeddedResources(Api api,
Map<String,String> embeddedKeys)
For a given Map finds any resources that should be embedded inside a class.
|
ResourceWithMetadata |
locateEntityResource(Api api,
String resourceName,
org.springframework.http.HttpMethod httpMethod)
Finds an Entity Resource and returns it in ResourceWithMetadata wrapper.
|
ResourceWithMetadata |
locateRelationPropertyResource(Api api,
String entityResource,
String relationResource,
String property,
org.springframework.http.HttpMethod httpMethod)
Finds a property or action on a Relationship Resource and returns it in ResourceWithMetadata wrapper.
|
Map<String,ResourceWithMetadata> |
locateRelationResource(Api api,
String entityKey,
Collection<String> relationshipKeys,
org.springframework.http.HttpMethod httpMethod)
Finds multiple relationship Resources and returns them as a Map of ResourceWithMetadata.
|
ResourceWithMetadata |
locateRelationResource(Api api,
String resourceName,
String relationName,
org.springframework.http.HttpMethod httpMethod)
Finds an Relationship Resource and returns it in ResourceWithMetadata wrapper.
|
ResourceWithMetadata |
locateResource(Api api,
Map<String,String> templateVars,
org.springframework.http.HttpMethod httpMethod)
Used by webscripts to locate a resource based on the URL template variables.
|
static final String COLLECTION_RESOURCE
static final String ENTITY_ID
static final String RELATIONSHIP_RESOURCE
static final String RELATIONSHIP_ID
static final String PROPERTY
ResourceWithMetadata locateEntityResource(Api api, String resourceName, org.springframework.http.HttpMethod httpMethod) throws InvalidArgumentException, UnsupportedResourceOperationException
api
- - The API being used.resourceName
- - 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.ResourceWithMetadata locateRelationPropertyResource(Api api, String entityResource, String relationResource, String property, org.springframework.http.HttpMethod httpMethod) throws InvalidArgumentException, UnsupportedResourceOperationException
api
- - The API being used.resourceName
- - The entity resource name - this is the "entityResourceName" property on the @RelationshipResource annotation.relationName
- - The relationship resource name - this is the "name" property on the @RelationshipResource annotation.property
- - The property resource name - can be either an action or a @BinaryPropertyhttpMethod
- - 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.ResourceWithMetadata locateRelationResource(Api api, String resourceName, String relationName, org.springframework.http.HttpMethod httpMethod) throws InvalidArgumentException, UnsupportedResourceOperationException
api
- - The API being used.resourceName
- - The entity resource name - this is the "entityResourceName" property on the @RelationshipResource annotation.relationName
- - 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.ResourceWithMetadata locateResource(Api api, Map<String,String> templateVars, org.springframework.http.HttpMethod httpMethod)
api
- - The API being used.templateVars
- A map of variables representing the requesthttpMethod
- - A permitted HttpMethodMap<String,ResourceWithMetadata> locateEmbeddedResources(Api api, Map<String,String> embeddedKeys)
api
- - The API being used.embeddedKeys
- - Likely to be the result of a call to ResourceInspector.findEmbeddedResources()Map<String,ResourceWithMetadata> locateRelationResource(Api api, String entityKey, Collection<String> relationshipKeys, org.springframework.http.HttpMethod httpMethod) throws InvalidArgumentException, UnsupportedResourceOperationException
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 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.Copyright © 2005–2017 Alfresco Software. All rights reserved.