Package org.pentaho.di.connections

Interface ConnectionDetails

All Known Subinterfaces:

VFSConnectionDetails

All Known Implementing Classes:

BaseVFSConnectionDetails, OtherConnectionDetails

public interface ConnectionDetails

Created by bmorrise on 2/13/19.

Method Summary

Modifier and Type	Method	Description
default ConnectionDetails	cloneDetails()	Clones the connection details instance.
default void	closeDialog()
String	getDescription()
String	getName()
default Map<String,String>	getProperties()	Gets props associated with this ConnectionDetails.
VariableSpace	getSpace()
String	getType()
default Object	openDialog(Object wTabFolder, Object propsUI)	Deprecated. Kept for backwards compatibility only.
default Object	openDialog(Bowl bowl, Object wTabFolder, Object propsUI)
default void	setDescription(String description)
void	setName(String name)
void	setSpace(VariableSpace space)

Method Details

getName

String getName()

setName

void setName(String name)

getType

String getType()

getDescription

String getDescription()

getProperties

default Map<String,String> getProperties()

Gets props associated with this ConnectionDetails. Allows implementors to expose connection properties without requiring clients to have the implementation as a dependency.

openDialog

default Object openDialog(Bowl bowl,
 Object wTabFolder,
 Object propsUI)

openDialog

@Deprecated
default Object openDialog(Object wTabFolder,
 Object propsUI)

Deprecated.

Kept for backwards compatibility only. Use the version with the Bowl

closeDialog

default void closeDialog()

setDescription

default void setDescription(String description)

getSpace

VariableSpace getSpace()

setSpace

void setSpace(VariableSpace space)

cloneDetails

default ConnectionDetails cloneDetails()
                                throws org.pentaho.metastore.api.exceptions.MetaStoreException

Clones the connection details instance.

The default implementation delegates cloning to ConnectionDetailsUtils.cloneMeta(ConnectionDetails).

Returns:

The cloned connection details.

Throws:

org.pentaho.metastore.api.exceptions.MetaStoreException