Interface URIInfoUtility
These methods automatically take into account EBX® server's configuration and current context such as REST proxy configuration and REST Forward modes.
- Since:
- 5.9.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescription<T extends URIBuilderForBuiltin<T>>
TcreateBuilderForBuiltin
(CategoryURIBuilder<T> aCategoryURIBuilder) Creates aURI
builder useful for generating URIs for the EBX® built-in REST services.<T extends URIBuilderForBuiltin<T>>
TcreateBuilderForBuiltin
(CategoryURIBuilder<T> aCategoryURIBuilder, boolean isRequestQueryParamsPropagated) Creates aURI
builder useful for generating URIs for the EBX® built-in REST services.Creates aURI
builder for generating URIs or URLs for resources packaged with the current module.createBuilderForResource
(String aModuleName) Creates aURI
builder for generating URIs or URLs for resources packaged with a specified module.Creates aURI
builder for generating URIs or URLs for REST services associated to the current REST application.Creates a URI builder for generating URIs or URLs for resources hosted by the current server.Returns the EBX® built-in REST services baseURI
.Returns the REST application baseURI
for the current application.Returns the server baseURI
.
-
Method Details
-
createBuilderForBuiltin
<T extends URIBuilderForBuiltin<T>> T createBuilderForBuiltin(CategoryURIBuilder<T> aCategoryURIBuilder) throws IllegalArgumentException Creates aURI
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.- Throws:
IllegalArgumentException
- See Also:
-
createBuilderForBuiltin
<T extends URIBuilderForBuiltin<T>> T createBuilderForBuiltin(CategoryURIBuilder<T> aCategoryURIBuilder, boolean isRequestQueryParamsPropagated) throws IllegalArgumentException Creates aURI
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 baseURI
is automatically initialized by the REST Toolkit depending on the current request.- Parameters:
aCategoryURIBuilder
- the service categoryURI
builder which is declared as a constant inCategoryURIBuilder
. It specifies for which REST category theURI
builder will be used.isRequestQueryParamsPropagated
-true
if theURI
builder must be initialized with the current HTTP request's query parameters,false
otherwise.- Returns:
- the appropriate
URI
builder for the providedaCategoryURIBuilder
. - Throws:
IllegalArgumentException
- ifaCategoryURIBuilder
isnull
- Since:
- 6.0.0
- See Also:
-
createBuilderForResource
Creates aURI
builder for generating URIs or URLs for resources packaged with the current module.- Throws:
ModuleNotFoundException
- See Also:
-
createBuilderForResource
Creates aURI
builder for generating URIs or URLs for resources packaged with a specified module.- Parameters:
aModuleName
- the specified module name, ifnull
or empty, the current module is used- Throws:
ModuleNotFoundException
- the module is not registered
-
createBuilderForRESTApplication
UriBuilder createBuilderForRESTApplication()Creates aURI
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 extendingRESTApplicationAbstract
.Overriding already provided values is not supported and must be avoided.
- See Also:
-
createBuilderForServer
UriBuilder createBuilderForServer()Creates a URI builder for generating URIs or URLs for resources hosted by the current server.The builder is initialized using the
getBaseURIForServer()
method.Overriding already provided values is not supported and must be avoided.
-
getBaseURIForBuiltin
URI getBaseURIForBuiltin()Returns the EBX® built-in REST services baseURI
.- Since:
- 6.0.0
- See Also:
-
getBaseURIForRESTApplication
URI getBaseURIForRESTApplication()Returns the REST application baseURI
for the current application.- See Also:
-
getBaseURIForServer
URI getBaseURIForServer()Returns the server baseURI
.- See Also:
-