com.orchestranetworks.rest.util

Interface URIBuilderForBuiltin.ForNode<T extends URIBuilderForBuiltin<T>>

All Superinterfaces:

URIBuilderForBuiltin<T>

All Known Subinterfaces:

URIBuilderForBuiltin.ForDataAndHistory

Enclosing interface:

URIBuilderForBuiltin<T extends URIBuilderForBuiltin<T>>

public static interface URIBuilderForBuiltin.ForNode<T extends URIBuilderForBuiltin<T>>
extends URIBuilderForBuiltin<T>

Contains methods to generate built-in REST services URI to a record field or a dataset node.

Since:

6.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.orchestranetworks.rest.util.URIBuilderForBuiltin

URIBuilderForBuiltin.ForDataAndHistory, URIBuilderForBuiltin.ForDataset<T extends URIBuilderForBuiltin<T>>, URIBuilderForBuiltin.ForDataspace<T extends URIBuilderForBuiltin<T>>, URIBuilderForBuiltin.ForNode<T extends URIBuilderForBuiltin<T>>, URIBuilderForBuiltin.ForRecord<T extends URIBuilderForBuiltin<T>>, URIBuilderForBuiltin.ForTable<T extends URIBuilderForBuiltin<T>>

Method Summary

Modifier and Type	Method and Description
URI	buildForNode(Adaptation aRecordOrDataset, Path aNodePath) Returns an absolute URI to a specified record field or a dataset node, in its automatically computed dataspace.
URI	buildForNode(HomeKey aDataspaceKey, AdaptationName aDatasetName, Path aNodePath) Returns an absolute URI to a specified dataset node, in a specified dataspace.
UriBuilder	node(Adaptation aRecordOrDataset, Path aNodePath) Returns a configured URI builder which can generate built-in REST services URI to a specified record field or dataset node, in its automatically computed dataspace.
UriBuilder	node(HomeKey aDataspaceKey, AdaptationName aDatasetName, Path aNodePath) Returns a configured URI builder which can generate built-in REST services URI to a specified dataset node, in a specified dataspace.

Methods inherited from interface com.orchestranetworks.rest.util.URIBuilderForBuiltin

build, extendedAction, firstPage, lastPage, nextPage, pageSize, previousPage, queryParams, queryParams

Method Detail

buildForNode

URI buildForNode(Adaptation aRecordOrDataset,
                 Path aNodePath)

Returns an absolute URI to a specified record field or a dataset node, in its automatically computed dataspace.

Parameters:

aRecordOrDataset - the record or dataset

aNodePath - the path node

See Also:

buildForNode(HomeKey, AdaptationName, Path)

node

UriBuilder node(Adaptation aRecordOrDataset,
                Path aNodePath)

Returns a configured URI builder which can generate built-in REST services URI to a specified record field or dataset node, in its automatically computed dataspace.

Parameters:

aRecordOrDataset - the record or dataset

aNodePath - the path node

See Also:

node(HomeKey, AdaptationName, Path)

buildForNode

URI buildForNode(HomeKey aDataspaceKey,
                 AdaptationName aDatasetName,
                 Path aNodePath)

Returns an absolute URI to a specified dataset node, in a specified dataspace.

If query parameters must be added to the generated URI, then the URIBuilderForBuiltin.queryParams(Map) or URIBuilderForBuiltin.queryParams(MultivaluedMap) method has to be invoked before this one.

If pagination query parameters must be added to the generated URI, then the URIBuilderForBuiltin.firstPage(), URIBuilderForBuiltin.lastPage(), URIBuilderForBuiltin.nextPage(String), URIBuilderForBuiltin.previousPage(String) or URIBuilderForBuiltin.pageSize(int) method has to be invoked before this one.

If an extended action must be added to the generated URI, then the URIBuilderForBuiltin.extendedAction(String) method has to be invoked before this one.

Parameters:

aDataspaceKey - the dataspace key

aDatasetName - the dataset name

aNodePath - the path node

See Also:

Data operations documentation

node

UriBuilder node(HomeKey aDataspaceKey,
                AdaptationName aDatasetName,
                Path aNodePath)

Returns a configured URI builder which can generate built-in REST services URI to a specified dataset node, in a specified dataspace.

Since a URI builder is returned, it is still possible to manipulate the preconfigured URI afterward.

To handle query parameters, the methods URIBuilderForBuiltin.queryParams(Map), URIBuilderForBuiltin.queryParams(MultivaluedMap) or UriBuilder.queryParam(String, Object...) should be used.

To handle pagination query parameters, the methods @link #firstPage()}, URIBuilderForBuiltin.lastPage(), URIBuilderForBuiltin.nextPage(String), URIBuilderForBuiltin.previousPage(String), URIBuilderForBuiltin.pageSize(int) or UriBuilder.queryParam(String, Object...) should be used.

To handle extended actions, the methods URIBuilderForBuiltin.extendedAction(String), UriBuilder.replacePath(String), UriBuilder.path(String) or UriBuilder.segment(String...) should be used.

Parameters:

aDataspaceKey - the dataspace key

aDatasetName - the dataset name

aNodePath - the path node

See Also:

Data operations documentation