Package com.streambase.liveview.client.serverdatautility

Interface ServerUtilityDataProvider

public interface ServerUtilityDataProvider

The Interface provides methods to fetch server utility data

Since:

2.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ServerUtilityDataProvider.DATA_POLICY	Enum for specifying the policy that should be used for importing LiveView metadata.

Method Summary

Modifier and Type	Method	Description
void	exportMetadata(File file, String... resources)	utility to export LiveView metadata.
void	exportMetadata(OutputStream outputStream, String... resources)	Utility to export LiveView metadata.
StreambaseStreams	getStreambaseStreams(String sbUri)	Utility to get all the input streams and output streams for a given Streambase URI.
Map<String,DataStatus>	importMetadata(File file, ServerUtilityDataProvider.DATA_POLICY dataPolicy, String... resources)	Utility to import LiveView metadata.
Map<String,DataStatus>	importMetadata(InputStream inputstream, ServerUtilityDataProvider.DATA_POLICY dataPolicy, String... resources)	Utility to import LiveView metadata.

Method Detail

importMetadata

Map<String,DataStatus> importMetadata(File file,
                                            ServerUtilityDataProvider.DATA_POLICY dataPolicy,
                                            String... resources)
                                     throws LiveViewException

Utility to import LiveView metadata.

Parameters:

file - the File that has the Json formatted data to be imported into LiveView.

dataPolicy - the ServerUtilityDataProvider.DATA_POLICY to use during the import process.

resources - the LiveView resources to import such as alerts, workspaces and lvweb ('lvweb' is a high level representation for all LiveView web resources that will fetch all the web resources; to fetch the detailed list of web resources, use #getSupportedMetadataResources()). If you do not provide any LiveView resources, the method helps you import all the data from the input file.

Returns:

the Map where the key identifies the resource and the value DataStatus gives the details of import process for the corresponding resource.

Throws:

LiveViewException - throws LiveView exception in case of error while importing the data.

Since:

10.3

importMetadata

Map<String,DataStatus> importMetadata(InputStream inputstream,
                                            ServerUtilityDataProvider.DATA_POLICY dataPolicy,
                                            String... resources)
                                     throws LiveViewException

Utility to import LiveView metadata.

Parameters:

inputstream - the InputStream to import the LiveView metadata from.

dataPolicy - the ServerUtilityDataProvider.DATA_POLICY to use during the import process.

resources - the LiveView resources to import such as alerts, workspaces and lvweb ('lvweb' is a high level representation for all LiveView web resources that will fetch all the web resources; to fetch the detailed list of web resources, use #getSupportedMetadataResources()). If you do not provide any LiveView resources, the method helps you import all the data from the input file.

Returns:

the Map where the key identifies the resource and DataStatus gives the details of import process for the corresponding resource.

Throws:

LiveViewException - throws LiveView exception in case of error while importing the data.

Since:

10.3

exportMetadata

void exportMetadata(File file,
                    String... resources)
             throws LiveViewException

utility to export LiveView metadata.

Parameters:

file - the File to which the exported data is to be written.

resources - the LiveView resources to export such as alerts, workspaces and lvweb ('lvweb' is a high level representation for all LiveView web resources that will fetch all the web resources; to fetch the detailed list of web resources, use #getSupportedMetadataResources()). If you do not provide any LiveView resources, all the LiveView metadata from the server is exported.

Throws:

LiveViewException - throws LiveView exception in case of error while exporting the data.

Since:

10.3

exportMetadata

void exportMetadata(OutputStream outputStream,
                    String... resources)
             throws LiveViewException

Utility to export LiveView metadata.

Parameters:

outputStream - the OutputStream to which the exported data is to be written.

resources - the LiveView resources to export such as alerts, workspaces and lvweb ('lvweb' is a high level representation for all LiveView web resources that will fetch all the web resources; to fetch the detailed list of web resources, use #getSupportedMetadataResources()). If you do not provide any LiveView resources, all the LiveView metadata from the server is exported.

Throws:

LiveViewException - throws LiveView exception in case of error while exporting the data.

Since:

10.3

getStreambaseStreams

StreambaseStreams getStreambaseStreams(String sbUri)
                                throws LiveViewException

Utility to get all the input streams and output streams for a given Streambase URI. Returns StreambaseStreams which has all the input and output streams for a given Streambase URI.

Throws:

LiveViewException