public interface URIInfoUtility
These methods automatically take into account EBX® server's configuration and current context such as REST proxy configuration and REST Forward modes.
SessionContext.getURIInfoUtility()
Modifier and Type | Method and Description |
---|---|
<T extends URIBuilderForBuiltin<T>> |
createBuilderForBuiltin(CategoryURIBuilder<T> aCategoryURIBuilder)
Creates a
URI builder useful for generating URIs for the
EBX® built-in REST services. |
<T extends URIBuilderForBuiltin<T>> |
createBuilderForBuiltin(CategoryURIBuilder<T> aCategoryURIBuilder,
boolean isRequestQueryParamsPropagated)
Creates a
URI builder useful for generating URIs for the
EBX® built-in REST services. |
URIBuilderForResource |
createBuilderForResource()
Creates a
URI builder for generating URIs or URLs for resources packaged
with the current module. |
URIBuilderForResource |
createBuilderForResource(String aModuleName)
Creates a
URI builder for generating URIs or URLs for resources packaged
with a specified module. |
UriBuilder |
createBuilderForRESTApplication()
Creates a
URI builder for generating URIs or URLs for REST services associated
to the current REST application. |
UriBuilder |
createBuilderForServer()
Creates a URI builder for generating URIs or URLs for resources hosted
by the current server.
|
URI |
getBaseURIForBuiltin()
Returns the EBX® built-in REST services base
URI . |
URI |
getBaseURIForRESTApplication()
Returns the REST application base
URI for the current application. |
URI |
getBaseURIForServer()
Returns the server base
URI . |
<T extends URIBuilderForBuiltin<T>> T createBuilderForBuiltin(CategoryURIBuilder<T> aCategoryURIBuilder) throws IllegalArgumentException
URI
builder useful for generating URIs for the
EBX® built-in REST services.
The URI
builder will not be initialized with the
current HTTP request's query parameters.
IllegalArgumentException
createBuilderForBuiltin(CategoryURIBuilder, boolean)
<T extends URIBuilderForBuiltin<T>> T createBuilderForBuiltin(CategoryURIBuilder<T> aCategoryURIBuilder, boolean isRequestQueryParamsPropagated) throws IllegalArgumentException
URI
builder useful for generating URIs for the
EBX® built-in REST services.
The builder is initialized with the built-in data services base URI
.
The data services base URI
is automatically initialized by the
REST Toolkit depending on the current request.
aCategoryURIBuilder
- the service category URI
builder which is declared as a constant in
CategoryURIBuilder
. It specifies for which REST category the
URI
builder will be used.isRequestQueryParamsPropagated
- true
if the URI
builder must be initialized with the
current HTTP request's query parameters, false
otherwise.URI
builder for the provided aCategoryURIBuilder
.IllegalArgumentException
- if aCategoryURIBuilder
is null
URIBuilderForResource createBuilderForResource() throws ModuleNotFoundException
URI
builder for generating URIs or URLs for resources packaged
with the current module.ModuleNotFoundException
createBuilderForResource(String)
URIBuilderForResource createBuilderForResource(String aModuleName) throws ModuleNotFoundException
URI
builder for generating URIs or URLs for resources packaged
with a specified module.aModuleName
- the specified module name, if null
or empty, the current module is usedModuleNotFoundException
- the module is not registeredUriBuilder createBuilderForRESTApplication()
URI
builder for generating URIs or URLs for REST services associated
to the current REST application.
The base path is the one specified by the annotation ApplicationPath
defined on the class extending RESTApplicationAbstract
.
Overriding already provided values is not supported and must be avoided.
UriBuilder createBuilderForServer()
The builder is initialized using the getBaseURIForServer()
method.
Overriding already provided values is not supported and must be avoided.
URI getBaseURIForBuiltin()
URI
.createBuilderForBuiltin(CategoryURIBuilder)
URI getBaseURIForRESTApplication()
URI
for the current application.createBuilderForRESTApplication()
URI getBaseURIForServer()
URI
.createBuilderForServer()