Uses of Class
org.alfresco.rest.framework.Api
Packages that use Api
Package
Description
-
Uses of Api in org.alfresco.rest.api
Methods in org.alfresco.rest.api with parameters of type ApiModifier and TypeMethodDescriptionvoid
NetworksWebScriptGet.execute
(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res) void
NetworkWebScriptGet.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 ApiMethods in org.alfresco.rest.framework that return ApiMethods in org.alfresco.rest.framework with parameters of type Api -
Uses of Api in org.alfresco.rest.framework.core
Methods in org.alfresco.rest.framework.core that return ApiModifier and TypeMethodDescriptionResourceMetadata.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 ApiModifier and TypeMethodDescriptionResourceDictionary.getAllResources()
ResourceDictionary.getPrivateApis()
ResourceDictionary.getPublicApis()
Methods in org.alfresco.rest.framework.core with parameters of type ApiModifier and TypeMethodDescriptionstatic void
ResourceInspector.inspectAddressedProperties
(Api api, Class<?> resource, String entityPath, List<ResourceMetadata> metainfo) Inspects the entity resource and returns meta data about any addresssed/binary propertiesstatic void
ResourceInspector.inspectOperations
(Api api, Class<?> resource, String entityPath, List<ResourceMetadata> metainfo) Inspect a resource to find operations on it.ResourceLocator.locateEmbeddedResources
(Api api, Map<String, String> embeddedKeys) For a given Map finds any resources that should be embedded inside a class.ResourceLookupDictionary.locateEmbeddedResources
(Api api, Map<String, String> embeddedKeys) ResourceLocator.locateEntityResource
(Api api, String resourceName, org.springframework.http.HttpMethod httpMethod) Finds an Entity Resource and returns it in ResourceWithMetadata wrapper.ResourceLookupDictionary.locateEntityResource
(Api api, String entityResource, org.springframework.http.HttpMethod httpMethod) 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.ResourceLookupDictionary.locateRelationPropertyResource
(Api api, String entityResource, String relationResource, String property, org.springframework.http.HttpMethod httpMethod) ResourceLocator.locateRelationResource
(Api api, String resourceName, String relationName, org.springframework.http.HttpMethod httpMethod) Finds an Relationship Resource and returns it in ResourceWithMetadata wrapper.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.ResourceLookupDictionary.locateRelationResource
(Api api, String entityResource, String relationResource, org.springframework.http.HttpMethod httpMethod) ResourceLookupDictionary.locateRelationResource
(Api api, String entityKey, Collection<String> relationshipKeys, org.springframework.http.HttpMethod httpMethod) 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.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 ApiModifierConstructorDescriptionApiScopeKey
(Api api) OperationResourceMetaData
(String uniqueId, List<ResourceOperation> operations, Api api, Method operationMethod, boolean noAuthRequired) Use this constructor to create the resource metadataOperationResourceMetaData
(String uniqueId, Api api, Set<Class<? extends ResourceAction>> apiDeleted, boolean noAuthRequired) Constructor to use when it has been deletedResourceMetadata
(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 ApiModifier and TypeMethodDescriptionstatic 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 ApiModifier and TypeMethodDescriptionvoid
AbstractResourceWebScript.execute
(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res) abstract void
ApiWebScript.execute
(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res) 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 ApiModifier and TypeMethodDescriptionvoid
InfoWebScriptGet.execute
(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res) void
WebScriptOptionsMetaData.execute
(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)