Package com.appliedolap.essbase

Interface EssConnection

All Superinterfaces:

EssObject

All Known Implementing Classes:

EssConnectionImpl

public interface EssConnection
extends EssObject

A named, reusable pointer to somewhere data lives, plus how to reach it.

Deliberately says nothing about which data - that is an EssDataSource, which is built on top of one of these. The split is about lifetime: credentials and locations change rarely and are sensitive, queries change constantly, and many data sources can share one connection.

A file connection names a single file in the catalogue, not a folder.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	EssConnection.ConnectionType	The kinds of connection Essbase models.

Nested classes/interfaces inherited from interface com.appliedolap.essbase.EssObject

EssObject.Type

Method Summary

Modifier and Type	Method	Description
void	delete()
EssConnection.ConnectionType	getConnectionType()
String	getDescription()
String	getHost()	The host a database connection points at, or null for a file connection.
String	getPath()	For a file connection, the catalogue path of the file - /gallery/Technical/Filters/UserDetails.csv.
Optional<String>	test()	Checks the connection without saving anything.

Methods inherited from interface com.appliedolap.essbase.EssObject

getName, getType

Method Details

getConnectionType

EssConnection.ConnectionType getConnectionType()

getDescription

String getDescription()

getPath

String getPath()

For a file connection, the catalogue path of the file - /gallery/Technical/Filters/UserDetails.csv. Null for a connection that isn't file-based.

Returns:

the path, or null

getHost

String getHost()

The host a database connection points at, or null for a file connection.

test

Optional<String> test()

Checks the connection without saving anything.

Returns:

empty when it connects, otherwise the server's reason

delete

void delete()