com.sap.sl.sdk.authoring.cms

Interface DataFederatorService

public interface DataFederatorService

Manages services for connections to Data Federator Query Server.

Method Summary

Modifier and Type	Method and Description
void	closeServerConnection() Closes the connection to the Data Federator Query Server.
void	deploy(ConnectionShortcut connection, java.lang.String catalog) Deploys the connection to the Data Federator Query Server.
java.lang.String	getCatalog(ConnectionShortcut connection) Retrieves the catalog of the provided connection.
void	undeploy(java.lang.String catalog) Unregisters the connection from the Data Federator Query Server.

Method Detail

getCatalog

java.lang.String getCatalog(ConnectionShortcut connection)

Retrieves the catalog of the provided connection.

A catalog identifies a connection in the Data Federator Query Server. The catalog is unique for a connection in the CMS.

A connection to the Data Federator Query Server can be open if needed, but not closed.

The connection can be loaded using LocalResourceService.load(String).

Parameters:

connection - Only RelationalConnectionShortcut and DataFederatorConnectionShortcut are supported

Returns:

A String that represents the catalog or null if the connection is not deployed to the Data Federator Query Server

Since:

14.0.5

See Also:

deploy(ConnectionShortcut, String), undeploy(String), closeServerConnection()

deploy

void deploy(ConnectionShortcut connection,
            java.lang.String catalog)

Deploys the connection to the Data Federator Query Server.

The user must have a download right on the connection.

The connection can be loaded using LocalResourceService.load(String).

Parameters:

connection - Only RelationalConnectionShortcut and DataFederatorConnectionShortcut are supported

catalog - A nonempty string

Since:

14.0.5

See Also:

getCatalog(ConnectionShortcut), closeServerConnection()

undeploy

void undeploy(java.lang.String catalog)

Unregisters the connection from the Data Federator Query Server.

Parameters:

catalog - A nonempty string

Since:

14.1

closeServerConnection

void closeServerConnection()

Closes the connection to the Data Federator Query Server. Does nothing if there is no open connection.

The connection closes when the SlContext is closed. It does not close the enterprise session.

Since:

14.0.5

See Also:

getCatalog(ConnectionShortcut), deploy(ConnectionShortcut, String)