public abstract class AbstractDelegatingResourceServiceBroker extends Object implements ResourceServiceBroker
| Constructor and Description |
|---|
AbstractDelegatingResourceServiceBroker(ResourceServiceBroker delegated) |
| Modifier and Type | Method and Description |
|---|---|
Resource |
findResources(String resourceSpace,
String baseAbsPath)
Resolves a proper
ResourceResolver by the specified resourceSpace and search Resource
representations from baseAbsPath and returns a parent Resource representation which contains
a collection of child Resource representations. |
Resource |
findResources(String resourceSpace,
String baseAbsPath,
ExchangeHint exchangeHint)
Resolves a proper
ResourceResolver by the specified resourceSpace and search Resource
representations from baseAbsPath and returns a parent Resource representation which contains
a collection of child Resource representations. |
Resource |
findResources(String resourceSpace,
String baseAbsPath,
Map<String,Object> pathVariables)
Resolves a proper
ResourceResolver by the specified resourceSpace and search Resource
representations from baseAbsPath and returns a parent Resource representation which contains
a collection of child Resource representations. |
Resource |
findResources(String resourceSpace,
String baseAbsPath,
Map<String,Object> pathVariables,
ExchangeHint exchangeHint)
Resolves a proper
ResourceResolver by the specified resourceSpace and search Resource
representations from baseAbsPath and returns a parent Resource representation which contains
a collection of child Resource representations. |
ResourceBeanMapper |
getResourceBeanMapper(String resourceSpace)
Returns a proper
ResourceBeanMapper for the given resourceSpace. |
ResourceDataCache |
getResourceDataCache(String resourceSpace)
Returns a proper resource cache store representation (
ResourceDataCache) for the specified
resourceSpace, or null if caching is disabled. |
Resource |
resolve(String resourceSpace,
String absPath)
Resolves a proper
ResourceResolver by the specified resourceSpace and resolves single Resource
representation by absPath. |
Resource |
resolve(String resourceSpace,
String absPath,
ExchangeHint exchangeHint)
Resolves a proper
ResourceResolver by the specified resourceSpace and resolves single Resource
representation by absPath. |
Resource |
resolve(String resourceSpace,
String absPath,
Map<String,Object> pathVariables)
Resolves a proper
ResourceResolver by the specified resourceSpace and resolves single Resource
representation by absPath. |
Resource |
resolve(String resourceSpace,
String absPath,
Map<String,Object> pathVariables,
ExchangeHint exchangeHint)
Resolves a proper
ResourceResolver by the specified resourceSpace and resolves single Resource
representation by absPath. |
Binary |
resolveBinary(String resourceSpace,
String absPath)
Resolves a proper
ResourceResolver by the specified resourceSpace and resolves single Binary
representation by absPath. |
Binary |
resolveBinary(String resourceSpace,
String absPath,
ExchangeHint exchangeHint)
Resolves a proper
ResourceResolver by the specified resourceSpace and resolves single Binary
representation by absPath. |
Binary |
resolveBinary(String resourceSpace,
String absPath,
Map<String,Object> pathVariables)
Resolves a proper
ResourceResolver by the specified resourceSpace and resolves single Binary
representation by absPath. |
Binary |
resolveBinary(String resourceSpace,
String absPath,
Map<String,Object> pathVariables,
ExchangeHint exchangeHint)
Resolves a proper
ResourceResolver by the specified resourceSpace and resolves single Binary
representation by absPath. |
Resource |
resolveBinaryAsResource(String resourceSpace,
String absPath)
Resolves a proper
ResourceResolver by the specified resourceSpace, resolves single Binary
representation by absPath, and converts the Binary representation into a Resource. |
Resource |
resolveBinaryAsResource(String resourceSpace,
String absPath,
ExchangeHint exchangeHint)
Resolves a proper
ResourceResolver by the specified resourceSpace, resolves single Binary
representation by absPath, and converts the Binary representation into a Resource. |
Resource |
resolveBinaryAsResource(String resourceSpace,
String absPath,
Map<String,Object> pathVariables)
Resolves a proper
ResourceResolver by the specified resourceSpace, resolves single Binary
representation by absPath, and converts the Binary representation into a Resource. |
Resource |
resolveBinaryAsResource(String resourceSpace,
String absPath,
Map<String,Object> pathVariables,
ExchangeHint exchangeHint)
Resolves a proper
ResourceResolver by the specified resourceSpace, resolves single Binary
representation by absPath, and converts the Binary representation into a Resource. |
URI |
resolveFullURI(String resourceSpace,
String absPath)
Resolves a full URI determined and resolved for the specific
resourceSpace and the absPath. |
URI |
resolveFullURI(String resourceSpace,
String absPath,
Map<String,Object> pathVariables)
Resolves a full URI determined and resolved for the specific
resourceSpace and the absPath. |
ResourceLink |
resolveLink(String resourceSpace,
Resource resource)
Resolves a proper
ResourceResolver by the specified resourceSpace and resolves a ResourceLink
for the given resource. |
ResourceLink |
resolveLink(String resourceSpace,
Resource resource,
Map<String,Object> linkVariables)
Resolves a proper
ResourceResolver by the specified resourceSpace and resolves a ResourceLink
for the given resource with passing linkVariables that can be used by implementation to
expand its internal link generation template. |
public AbstractDelegatingResourceServiceBroker(ResourceServiceBroker delegated)
public Resource resolve(String resourceSpace, String absPath) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and resolves single Resource
representation by absPath.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
resolve in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a ResourceResource representation by absPathResourceException - if resource resolution operation failspublic Resource resolve(String resourceSpace, String absPath, ExchangeHint exchangeHint) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and resolves single Resource
representation by absPath.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
If a non-null exchangeHint is given, then it can be understood by the specific ResourceResolver
implementation for its specific backend.
resolve in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a ResourceexchangeHint - a message exchange hint for the backendResource representation by absPathResourceException - if resource resolution operation failspublic Resource resolve(String resourceSpace, String absPath, Map<String,Object> pathVariables) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and resolves single Resource
representation by absPath.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
The absPath template is expanded using the given path variables (pathVariables), if any.
For example, if pathVariables looks like {"var1":"hello","var2":"world"}
and absPath is ".../some/path/{var1}/{var2}/overview", then it is expanded to
".../some/path/hello/world/overview" by the pathVariables when making a real request
to the backend.
resolve in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a ResourcepathVariables - the variables to expand the template given by absPathResource representation by absPathResourceException - if resource resolution operation failspublic Resource resolve(String resourceSpace, String absPath, Map<String,Object> pathVariables, ExchangeHint exchangeHint) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and resolves single Resource
representation by absPath.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
The absPath template is expanded using the given path variables (pathVariables), if any.
For example, if pathVariables looks like {"var1":"hello","var2":"world"}
and absPath is ".../some/path/{var1}/{var2}/overview", then it is expanded to
".../some/path/hello/world/overview" by the pathVariables when making a real request
to the backend.
If a non-null exchangeHint is given, then it can be understood by the specific ResourceResolver
implementation for its specific backend.
resolve in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a ResourcepathVariables - the variables to expand the template given by absPathexchangeHint - a message exchange hint for the backendResource representation by absPathResourceException - if resource resolution operation failspublic Binary resolveBinary(String resourceSpace, String absPath) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and resolves single Binary
representation by absPath.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
resolveBinary in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a BinaryBinary representation by absPathResourceException - if resource resolution operation failspublic Binary resolveBinary(String resourceSpace, String absPath, ExchangeHint exchangeHint) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and resolves single Binary
representation by absPath.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
If a non-null exchangeHint is given, then it can be understood by the specific ResourceResolver
implementation for its specific backend.
resolveBinary in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a BinaryexchangeHint - a message exchange hint for the backendBinary representation by absPathResourceException - if resource resolution operation failspublic Binary resolveBinary(String resourceSpace, String absPath, Map<String,Object> pathVariables) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and resolves single Binary
representation by absPath.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
The absPath template is expanded using the given path variables (pathVariables), if any.
For example, if pathVariables looks like {"var1":"hello","var2":"world"}
and absPath is ".../some/path/{var1}/{var2}/overview", then it is expanded to
".../some/path/hello/world/overview" by the pathVariables when making a real request
to the backend.
resolveBinary in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a BinarypathVariables - the variables to expand the template given by absPathBinary representation by absPathResourceException - if resource resolution operation failspublic Binary resolveBinary(String resourceSpace, String absPath, Map<String,Object> pathVariables, ExchangeHint exchangeHint) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and resolves single Binary
representation by absPath.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
The absPath template is expanded using the given path variables (pathVariables), if any.
For example, if pathVariables looks like {"var1":"hello","var2":"world"}
and absPath is ".../some/path/{var1}/{var2}/overview", then it is expanded to
".../some/path/hello/world/overview" by the pathVariables when making a real request
to the backend.
If a non-null exchangeHint is given, then it can be understood by the specific ResourceResolver
implementation for its specific backend.
resolveBinary in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a BinarypathVariables - the variables to expand the template given by absPathexchangeHint - a message exchange hint for the backendBinary representation by absPathResourceException - if resource resolution operation failspublic Resource resolveBinaryAsResource(String resourceSpace, String absPath) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace, resolves single Binary
representation by absPath, and converts the Binary representation into a Resource.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
resolveBinaryAsResource in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a BinaryResource object converted from the single Binary representation by absPathResourceException - if resource resolution operation failspublic Resource resolveBinaryAsResource(String resourceSpace, String absPath, ExchangeHint exchangeHint) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace, resolves single Binary
representation by absPath, and converts the Binary representation into a Resource.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
If a non-null exchangeHint is given, then it can be understood by the specific ResourceResolver
implementation for its specific backend.
resolveBinaryAsResource in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a BinaryexchangeHint - a message exchange hint for the backendResource object converted from the single Binary representation by absPathResourceException - if resource resolution operation failspublic Resource resolveBinaryAsResource(String resourceSpace, String absPath, Map<String,Object> pathVariables) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace, resolves single Binary
representation by absPath, and converts the Binary representation into a Resource.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
The absPath template is expanded using the given path variables (pathVariables), if any.
For example, if pathVariables looks like {"var1":"hello","var2":"world"}
and absPath is ".../some/path/{var1}/{var2}/overview", then it is expanded to
".../some/path/hello/world/overview" by the pathVariables when making a real request
to the backend.
resolveBinaryAsResource in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a BinarypathVariables - the variables to expand the template given by absPathResource object converted from the single Binary representation by absPathResourceException - if resource resolution operation failspublic Resource resolveBinaryAsResource(String resourceSpace, String absPath, Map<String,Object> pathVariables, ExchangeHint exchangeHint) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace, resolves single Binary
representation by absPath, and converts the Binary representation into a Resource.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
The absPath template is expanded using the given path variables (pathVariables), if any.
For example, if pathVariables looks like {"var1":"hello","var2":"world"}
and absPath is ".../some/path/{var1}/{var2}/overview", then it is expanded to
".../some/path/hello/world/overview" by the pathVariables when making a real request
to the backend.
If a non-null exchangeHint is given, then it can be understood by the specific ResourceResolver
implementation for its specific backend.
resolveBinaryAsResource in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a BinarypathVariables - the variables to expand the template given by absPathexchangeHint - a message exchange hint for the backendResource object converted from the single Binary representation by absPathResourceException - if resource resolution operation failspublic Resource findResources(String resourceSpace, String baseAbsPath) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and search Resource
representations from baseAbsPath and returns a parent Resource representation which contains
a collection of child Resource representations.
baseAbsPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then baseAbsPath can be a URI path or part of URL. Or, as
an example, the baseAbsPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
findResources in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverbaseAbsPath - base absolute path of a ResourceResource representation which contains a collection of child Resource representationsResourceException - if resource resolution operation failspublic Resource findResources(String resourceSpace, String baseAbsPath, ExchangeHint exchangeHint) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and search Resource
representations from baseAbsPath and returns a parent Resource representation which contains
a collection of child Resource representations.
baseAbsPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then baseAbsPath can be a URI path or part of URL. Or, as
an example, the baseAbsPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
If a non-null exchangeHint is given, then it can be understood by the specific ResourceResolver
implementation for its specific backend.
findResources in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverbaseAbsPath - base absolute path of a ResourceexchangeHint - a message exchange hint for the backendResource representation which contains a collection of child Resource representationsResourceException - if resource resolution operation failspublic Resource findResources(String resourceSpace, String baseAbsPath, Map<String,Object> pathVariables) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and search Resource
representations from baseAbsPath and returns a parent Resource representation which contains
a collection of child Resource representations.
baseAbsPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then baseAbsPath can be a URI path or part of URL. Or, as
an example, the baseAbsPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
The baseAbsPath template is expanded using the given path variables (pathVariables), if any.
For example, if pathVariables looks like {"var1":"hello","var2":"world"}
and baseAbsPath is ".../some/path/{var1}/{var2}/overview", then it is expanded to
".../some/path/hello/world/overview" by the pathVariables when making a real request
to the backend.
findResources in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverbaseAbsPath - base absolute path of a ResourcepathVariables - the variables to expand the template given by absPathResource representation which contains a collection of child Resource representationsResourceException - if resource resolution operation failspublic Resource findResources(String resourceSpace, String baseAbsPath, Map<String,Object> pathVariables, ExchangeHint exchangeHint) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and search Resource
representations from baseAbsPath and returns a parent Resource representation which contains
a collection of child Resource representations.
baseAbsPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then baseAbsPath can be a URI path or part of URL. Or, as
an example, the baseAbsPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
The baseAbsPath template is expanded using the given path variables (pathVariables), if any.
For example, if pathVariables looks like {"var1":"hello","var2":"world"}
and baseAbsPath is ".../some/path/{var1}/{var2}/overview", then it is expanded to
".../some/path/hello/world/overview" by the pathVariables when making a real request
to the backend.
If a non-null exchangeHint is given, then it can be understood by the specific ResourceResolver
implementation for its specific backend.
findResources in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverbaseAbsPath - base absolute path of a ResourcepathVariables - the variables to expand the template given by absPathexchangeHint - a message exchange hint for the backendResource representation which contains a collection of child Resource representationsResourceException - if resource resolution operation failspublic ResourceLink resolveLink(String resourceSpace, Resource resource) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and resolves a ResourceLink
for the given resource.resolveLink in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverresource - resource representationResourceLink for the given resourceResourceException - if resource resolution operation failspublic ResourceLink resolveLink(String resourceSpace, Resource resource, Map<String,Object> linkVariables) throws ResourceException
ResourceServiceBrokerResourceResolver by the specified resourceSpace and resolves a ResourceLink
for the given resource with passing linkVariables that can be used by implementation to
expand its internal link generation template.
How the linkVariables is used in link generation template expansion is totally up to an implementation.
resolveLink in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverresource - resource representationlinkVariables - the variables to expand the internal link generation templateResourceLink for the given resourceResourceException - if resource resolution operation failspublic ResourceDataCache getResourceDataCache(String resourceSpace) throws ResourceException
ResourceServiceBrokerResourceDataCache) for the specified
resourceSpace, or null if caching is disabled.
An implementation may return a default resource cache store representation (ResourceDataCache)
as a fallback if the resolved ResourceResolver doesn't have its own ResourceDataCache instance
(in other words, if the resolved ResourceCacheResolvable.getResourceDataCache() return null).
If an underlying resource resolver is explicitly disabled on caching (in other words, if the resolved
ResourceCacheResolvable.isCacheEnabled() returns false), it should return null.
getResourceDataCache in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverResourceDataCache) for the specified
resourceSpace, or a fallback ResourceDataCache if the resolved ResourceResolver
doesn't have its own ResourceDataCache instanceResourceException - if resource space is not foundpublic ResourceBeanMapper getResourceBeanMapper(String resourceSpace) throws ResourceException
ResourceServiceBrokerResourceBeanMapper for the given resourceSpace.getResourceBeanMapper in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverResourceBeanMapper for the given resourceSpaceResourceException - if resource space is not foundpublic URI resolveFullURI(String resourceSpace, String absPath) throws ResourceException
ResourceServiceBrokerresourceSpace and the absPath.
Or returns null if the backend cannot support a full URI access.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
resolveFullURI in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a ResourceabsPathResourceException - if resource resolution operation failspublic URI resolveFullURI(String resourceSpace, String absPath, Map<String,Object> pathVariables) throws ResourceException
ResourceServiceBrokerresourceSpace and the absPath.
Or returns null if the backend cannot support a full URI access.
absPath is a domain-specific path template that should be meaningful to the backend.
For example, if the backend is a REST API, then absPath can be a URI path or part of URL. Or, as
an example, the absPath can be an index name of a search index, table name of databases or node
path in JCR, totally depending on ResourceResolver implementations.
The absPath template is expanded using the given path variables (pathVariables), if any.
For example, if pathVariables looks like {"var1":"hello","var2":"world"}
and absPath is ".../some/path/{var1}/{var2}/overview", then it is expanded to
".../some/path/hello/world/overview" by the pathVariables.
resolveFullURI in interface ResourceServiceBrokerresourceSpace - Resource space name to resolve a proper ResourceResolverabsPath - absolute path of a ResourcepathVariables - the variables to expand the template given by absPathabsPathResourceException - if resource resolution operation failsCopyright © 2017–2020 Hippo B.V. (http://www.onehippo.com). All rights reserved.