Uses of Class
org.alfresco.rest.framework.Api

Packages that use Api

Package	Description
org.alfresco.rest.api
org.alfresco.rest.framework
org.alfresco.rest.framework.core
org.alfresco.rest.framework.tools
org.alfresco.rest.framework.webscripts
org.alfresco.rest.framework.webscripts.metadata

Uses of Api in org.alfresco.rest.api

Methods in org.alfresco.rest.api with parameters of type Api

Modifier and Type	Method and Description
void	NetworkWebScriptGet.execute(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)
void	NetworksWebScriptGet.execute(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)

Uses of Api in org.alfresco.rest.framework

Fields in org.alfresco.rest.framework declared as Api

Modifier and Type	Field and Description
static Api	Api.ALFRESCO_PUBLIC

Methods in org.alfresco.rest.framework that return Api

Modifier and Type	Method and Description
static Api	Api.valueOf(String apiName, String apiScope, String apiVersion) Creates an valid instance of the Api object

Methods in org.alfresco.rest.framework with parameters of type Api

Modifier and Type	Method and Description
int	Api.compareTo(Api other)

Uses of Api in org.alfresco.rest.framework.core

Methods in org.alfresco.rest.framework.core that return Api

Modifier and Type	Method and Description
Api	ResourceMetadata.getApi()
static Api	ResourceInspector.inspectApi(Class<?> resource) Inspects the resource to determine what api it belongs to.

Methods in org.alfresco.rest.framework.core that return types with arguments of type Api

Modifier and Type	Method and Description
Map<Api,Map<String,ResourceWithMetadata>>	ResourceDictionary.getAllResources()
SortedSet<Api>	ResourceDictionary.getPrivateApis()
SortedSet<Api>	ResourceDictionary.getPublicApis()

Methods in org.alfresco.rest.framework.core with parameters of type Api

Modifier and Type	Method and Description
static void	ResourceInspector.inspectAddressedProperties(Api api, Class<?> resource, String entityPath, List<ResourceMetadata> metainfo) Inspects the entity resource and returns meta data about any addresssed/binary properties
static void	ResourceInspector.inspectOperations(Api api, Class<?> resource, String entityPath, List<ResourceMetadata> metainfo) Inspect a resource to find operations on it.
Map<String,ResourceWithMetadata>	ResourceLocator.locateEmbeddedResources(Api api, Map<String,String> embeddedKeys) For a given Map finds any resources that should be embedded inside a class.
Map<String,ResourceWithMetadata>	ResourceLookupDictionary.locateEmbeddedResources(Api api, Map<String,String> embeddedKeys)
ResourceWithMetadata	ResourceLocator.locateEntityResource(Api api, String resourceName, org.springframework.http.HttpMethod httpMethod) Finds an Entity Resource and returns it in ResourceWithMetadata wrapper.
ResourceWithMetadata	ResourceLookupDictionary.locateEntityResource(Api api, String entityResource, org.springframework.http.HttpMethod httpMethod)
ResourceWithMetadata	ResourceLocator.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.
ResourceWithMetadata	ResourceLookupDictionary.locateRelationPropertyResource(Api api, String entityResource, String relationResource, String property, org.springframework.http.HttpMethod httpMethod)
Map<String,ResourceWithMetadata>	ResourceLocator.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.
Map<String,ResourceWithMetadata>	ResourceLookupDictionary.locateRelationResource(Api api, String entityKey, Collection<String> relationshipKeys, org.springframework.http.HttpMethod httpMethod)
ResourceWithMetadata	ResourceLocator.locateRelationResource(Api api, String resourceName, String relationName, org.springframework.http.HttpMethod httpMethod) Finds an Relationship Resource and returns it in ResourceWithMetadata wrapper.
ResourceWithMetadata	ResourceLookupDictionary.locateRelationResource(Api api, String entityResource, String relationResource, org.springframework.http.HttpMethod httpMethod)
ResourceWithMetadata	ResourceLocator.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.
ResourceWithMetadata	ResourceLookupDictionary.locateResource(Api api, Map<String,String> 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.

Constructors in org.alfresco.rest.framework.core with parameters of type Api

Constructor and Description
ApiScopeKey(Api api)
OperationResourceMetaData(String uniqueId, Api api, Set<Class<? extends ResourceAction>> apiDeleted, boolean noAuthRequired) Constructor to use when it has been deleted
OperationResourceMetaData(String uniqueId, List<ResourceOperation> operations, Api api, Method operationMethod, boolean noAuthRequired) Use this constructor to create the resource metadata
ResourceMetadata(String uniqueId, ResourceMetadata.RESOURCE_TYPE type, List<ResourceOperation> operations, Api api, Set<Class<? extends ResourceAction>> apiDeleted, Set<Class<? extends ResourceAction>> apiNoAuth, String parentResource)

Uses of Api in org.alfresco.rest.framework.tools

Methods in org.alfresco.rest.framework.tools that return Api

Modifier and Type	Method and Description
static Api	ApiAssistant.determineApi(Map<String,String> templateVars) Determines the api being used from the templateVars

Uses of Api in org.alfresco.rest.framework.webscripts

Methods in org.alfresco.rest.framework.webscripts with parameters of type Api

Modifier and Type	Method and Description
abstract void	ApiWebScript.execute(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)
void	AbstractResourceWebScript.execute(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)
Object	ResourceWebScriptHelper.processAdditionsToTheResponse(org.springframework.extensions.webscripts.WebScriptResponse res, Api api, String entityCollectionName, Params params, Object objectToWrap) Looks at the object passed in and recursively expands any @EmbeddedEntityResource annotations or related relationship.

Uses of Api in org.alfresco.rest.framework.webscripts.metadata

Methods in org.alfresco.rest.framework.webscripts.metadata with parameters of type Api

Modifier and Type	Method and Description
void	WebScriptOptionsMetaData.execute(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)
void	InfoWebScriptGet.execute(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)