com.orchestranetworks.rest.util

Interface URIBuilderForBuiltin

public interface URIBuilderForBuiltin

This class provides useful methods to generate URI to EBX® built-in REST services.

Since:

5.9.0

See Also:

Constants, Data services documentation, Built-in REST services documentation

Method Summary

Modifier and Type	Method and Description
URI	build() Returns an absolute base URI that includes category and version.
URI	buildForDataset(Adaptation aDataset) Returns an absolute URI for a specified dataset with empty query parameters.
URI	buildForDataset(Adaptation aDataset, Map<String,String> parameters) Returns an absolute URI to a specified dataset with the provided query parameters.
URI	buildForDataset(HomeKey aDataspaceKey, AdaptationName aDatasetName) Returns an absolute URI to a specified dataset in a specified dataspace with empty query parameters.
URI	buildForDataset(HomeKey aDataspaceKey, AdaptationName aDatasetName, Map<String,String> parameters) Returns an absolute URI to a specified dataset in a specified dataspace including the provided query parameters.
URI	buildForNode(Adaptation aRecordOrDataset, Path aNodePath) Returns an absolute URI to a specified record field or dataset node without query parameters.
URI	buildForNode(Adaptation aRecordOrDataset, Path aNodePath, Map<String,String> parameters) Returns an absolute URI to a specified record field or dataset node with query parameters.
URI	buildForNode(HomeKey aDataspaceKey, AdaptationName aDatasetName, Path aNodePath) Returns an absolute URI to a specified dataset node without query parameters.
URI	buildForNode(HomeKey aDataspaceKey, AdaptationName aDatasetName, Path aNodePath, Map<String,String> parameters) Returns an absolute URI to a specified dataset node with query parameters.
URI	buildForRecord(Adaptation aRecord) Returns an absolute URI to a specified record without query parameters.
URI	buildForRecord(Adaptation aRecord, Map<String,String> parameters) Returns an absolute URI to a specified record with query parameters.
URI	buildForTableFirstPage(Adaptation aRecord, SchemaNode aTableOrAssociationNode, int aPageSize, Map<String,String> parameters) Returns an absolute URI to access the first table page with query parameters.
URI	buildForTableLastPage(Adaptation aRecord, SchemaNode aTableOrAssociationNode, int aPageSize, Map<String,String> parameters) Returns an absolute URI to access the last table page with query parameters.
URI	buildForTableNextPage(Adaptation aRecord, SchemaNode aTableOrAssociationNode, String aPageRecordFilter, int aPageSize, Map<String,String> parameters) Returns an absolute URI to access the next table page with query parameters.
URI	buildForTablePreviousPage(Adaptation aRecord, SchemaNode aTableOrAssociationNode, String aPageRecordFilter, int aPageSize, Map<String,String> parameters) Returns an absolute URI to access the previous table page with query parameters.

Method Detail

build

URI build()

Returns an absolute base URI that includes category and version.

See Also:

URL definition

buildForDataset

URI buildForDataset(Adaptation aDataset)

Returns an absolute URI for a specified dataset with empty query parameters.

See Also:

buildForDataset(Adaptation, Map)

buildForDataset

URI buildForDataset(Adaptation aDataset,
                    Map<String,String> parameters)

Returns an absolute URI to a specified dataset with the provided query parameters.

Parameters:

aDataset - the dataset

parameters - the query parameters

See Also:

Data operations documentation

buildForDataset

URI buildForDataset(HomeKey aDataspaceKey,
                    AdaptationName aDatasetName)

Returns an absolute URI to a specified dataset in a specified dataspace with empty query parameters.

See Also:

buildForDataset(HomeKey, AdaptationName, Map)

buildForDataset

URI buildForDataset(HomeKey aDataspaceKey,
                    AdaptationName aDatasetName,
                    Map<String,String> parameters)

Returns an absolute URI to a specified dataset in a specified dataspace including the provided query parameters.

Parameters:

aDataspaceKey - the dataspace key

aDatasetName - the dataset name

parameters - the query parameters

See Also:

Data operations documentation

buildForNode

URI buildForNode(Adaptation aRecordOrDataset,
                 Path aNodePath)

Returns an absolute URI to a specified record field or dataset node without query parameters.

See Also:

buildForNode(Adaptation, Path, Map)

buildForNode

URI buildForNode(Adaptation aRecordOrDataset,
                 Path aNodePath,
                 Map<String,String> parameters)

Returns an absolute URI to a specified record field or dataset node with query parameters.

Parameters:

aRecordOrDataset - the record or dataset

aNodePath - the path node

parameters - the query parameters

See Also:

Data operations documentation

buildForNode

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

Returns an absolute URI to a specified dataset node without query parameters.

See Also:

buildForNode(HomeKey, AdaptationName, Path, Map)

buildForNode

URI buildForNode(HomeKey aDataspaceKey,
                 AdaptationName aDatasetName,
                 Path aNodePath,
                 Map<String,String> parameters)

Returns an absolute URI to a specified dataset node with query parameters.

Parameters:

aDataspaceKey - the dataspace key

aDatasetName - the dataset name

aNodePath - the path node

parameters - the query parameters

See Also:

Data operations documentation

buildForRecord

URI buildForRecord(Adaptation aRecord)

Returns an absolute URI to a specified record without query parameters.

See Also:

buildForRecord(Adaptation, Map)

buildForRecord

URI buildForRecord(Adaptation aRecord,
                   Map<String,String> parameters)

Returns an absolute URI to a specified record with query parameters.

Parameters:

aRecord - the record

parameters - the query parameters

See Also:

Data operations documentation

buildForTableFirstPage

URI buildForTableFirstPage(Adaptation aRecord,
                           SchemaNode aTableOrAssociationNode,
                           int aPageSize,
                           Map<String,String> parameters)

Returns an absolute URI to access the first table page with query parameters.

Parameters:

aRecord - the record

aTableOrAssociationNode - the table or association node

aPageSize - the table page size

parameters - the query parameters

See Also:

buildForTableLastPage(Adaptation, SchemaNode, int, Map), Data operations documentation

buildForTablePreviousPage

URI buildForTablePreviousPage(Adaptation aRecord,
                              SchemaNode aTableOrAssociationNode,
                              String aPageRecordFilter,
                              int aPageSize,
                              Map<String,String> parameters)

Returns an absolute URI to access the previous table page with query parameters.

Parameters:

aRecord - the record

aTableOrAssociationNode - the table or association node

aPageRecordFilter - the page record filter

aPageSize - the table page size

parameters - the query parameters

See Also:

buildForTableNextPage(Adaptation, SchemaNode, String, int, Map), Data operations documentation

buildForTableNextPage

URI buildForTableNextPage(Adaptation aRecord,
                          SchemaNode aTableOrAssociationNode,
                          String aPageRecordFilter,
                          int aPageSize,
                          Map<String,String> parameters)

Returns an absolute URI to access the next table page with query parameters.

Parameters:

aRecord - the record

aTableOrAssociationNode - the table or association node

aPageRecordFilter - the page record filter

aPageSize - the table page size

parameters - the query parameters

See Also:

buildForTablePreviousPage(Adaptation, SchemaNode, String, int, Map), Data operations documentation

buildForTableLastPage

URI buildForTableLastPage(Adaptation aRecord,
                          SchemaNode aTableOrAssociationNode,
                          int aPageSize,
                          Map<String,String> parameters)

Returns an absolute URI to access the last table page with query parameters.

Parameters:

aRecord - the record

aTableOrAssociationNode - the table or association node

aPageSize - the table page size

parameters - the query parameters

See Also:

buildForTableFirstPage(Adaptation, SchemaNode, int, Map), Data operations documentation