Package org.pentaho.di.connections.vfs

Class VFSConnectionManagerHelper

java.lang.Object

org.pentaho.di.connections.vfs.VFSConnectionManagerHelper

public class VFSConnectionManagerHelper
extends Object

The VFSConnectionManagerHelper class contains connection management logic which is VFS-specific.

Specifically, this class contains logic which is common to all VFS providers. Logic which is VFS-provider-specific is instead handled by implementations of VFSConnectionProvider<VFSConnectionDetails>.

The ConnectionManager delegates certain operations to this helper class, for VFSConnectionDetails connections. For example, this is the case of ConnectionManager.test(ConnectionDetails).

However, this class can also be used directly, to gain access to VFS-specific functionality, not exposed generically via ConnectionManager.

This pattern may work in the future if ConnectionManager is expanded to work with other connection types, such as database connections.

Constructor Summary

Constructors

Constructor	Description
VFSConnectionManagerHelper()
VFSConnectionManagerHelper(ConnectionFileNameUtils vfsConnectionFileNameUtils)

Method Summary

Modifier and Type	Method	Description
List<VFSConnectionDetails>	getAllDetails(ConnectionManager manager)
ConnectionFileName	getConnectionRootFileName(VFSConnectionDetails details)
<T extends VFSConnectionDetails> VFSConnectionProvider<T>	getExistingProvider(ConnectionManager manager, String key)	Gets a VFS connection provider, given its key, and throwing an exception if one is not defined.
<T extends VFSConnectionDetails> VFSConnectionProvider<T>	getExistingProvider(ConnectionManager manager, T details)	Gets a VFS provider, given the details of the VFS connection, and throwing an exception if one is not defined.
static VFSConnectionManagerHelper	getInstance()
<T extends VFSConnectionDetails> VFSConnectionProvider<T>	getProvider(ConnectionManager manager, String key)	Gets a VFS connection provider, given its key.
<T extends VFSConnectionDetails> VFSConnectionProvider<T>	getProvider(ConnectionManager manager, T details)	Gets a VFS provider, given the details of the VFS connection.
List<VFSConnectionProvider<VFSConnectionDetails>>	getProviders(ConnectionManager manager)
String	getResolvedRootPath(VFSConnectionDetails details)	Gets the resolved root path of a given connection.
protected String	normalizeRootPath(String rootPath)
<T extends VFSConnectionDetails> boolean	test(ConnectionManager manager, T details, VFSConnectionTestOptions options)	Tests if a VFS connection is valid, given its details, optionally, with certain testing options.
boolean	usesBuckets(VFSConnectionDetails details)	Indicates if a VFS connection, given its details, uses buckets in its current configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VFSConnectionManagerHelper

public VFSConnectionManagerHelper()

VFSConnectionManagerHelper

public VFSConnectionManagerHelper(@NonNull
 ConnectionFileNameUtils vfsConnectionFileNameUtils)

Method Details

getInstance

@NonNull
public static VFSConnectionManagerHelper getInstance()

getProviders

public List<VFSConnectionProvider<VFSConnectionDetails>> getProviders(@NonNull
 ConnectionManager manager)

getAllDetails

@NonNull
public List<VFSConnectionDetails> getAllDetails(@NonNull
 ConnectionManager manager)

getProvider

@Nullable
public <T extends VFSConnectionDetails>
VFSConnectionProvider<T> getProvider(@NonNull
 ConnectionManager manager,
 @Nullable
 String key)

Gets a VFS connection provider, given its key.

A provider key is either its own ConnectionProvider.getKey() or a registered alias, via ConnectionManager.addLookupFilter(LookupFilter).

This method will throw a ClassCastException exception if a provider with the given key is defined which is not of the expected type, VFSConnectionProvider<T extends VFSConnectionDetails>.

Parameters:

key - The VFS connection provider key.

Returns:

The VFS connection provider, if one exists; null, otherwise.

getExistingProvider

@NonNull
public <T extends VFSConnectionDetails>
VFSConnectionProvider<T> getExistingProvider(@NonNull
 ConnectionManager manager,
 @Nullable
 String key)
                                      throws KettleException

Gets a VFS connection provider, given its key, and throwing an exception if one is not defined.

A provider key is either its own ConnectionProvider.getKey() or a registered alias, via ConnectionManager.addLookupFilter(LookupFilter).

This method will throw a ClassCastException exception if a provider with the given key is defined which is not of the expected type, VFSConnectionProvider<T extends VFSConnectionDetails>.

Parameters:

key - The provider key.

Returns:

The VFS connection provider.

Throws:

KettleException - When a provider with the given key is not defined.

getProvider

@Nullable
public <T extends VFSConnectionDetails>
VFSConnectionProvider<T> getProvider(@NonNull
 ConnectionManager manager,
 @Nullable
 T details)

Gets a VFS provider, given the details of the VFS connection.

This method will throw a ClassCastException exception if a provider with the given key is defined which is not of the expected type, VFSConnectionProvider<T extends VFSConnectionDetails>.

Parameters:

details - The details of the VFS connection.

Returns:

The VFS connection provider, if one exists; null, otherwise.

getExistingProvider

@NonNull
public <T extends VFSConnectionDetails>
VFSConnectionProvider<T> getExistingProvider(@NonNull
 ConnectionManager manager,
 @NonNull
 T details)
                                      throws KettleException

Gets a VFS provider, given the details of the VFS connection, and throwing an exception if one is not defined.

Parameters:

details - The details of the VFS connection.

Returns:

The VFS connection provider.

Throws:

KettleException - When a provider with the given key is not defined.

getConnectionRootFileName

@NonNull
public ConnectionFileName getConnectionRootFileName(@NonNull
 VFSConnectionDetails details)

getResolvedRootPath

@Nullable
public String getResolvedRootPath(@NonNull
 VFSConnectionDetails details)
                           throws KettleException

Gets the resolved root path of a given connection.

This method returns the value of the root path after any variables substituted and subsequent normalization.

Root path normalization fixes separators, resolves "." and ".." segments, and removes any leading and trailing path separator.

Root path normalization does not affect the encoding of the original root path value, after variable substitution, which should be that of the specific connection/file provider.

Parameters:

details - The VFS connection details.

Returns:

The non-empty resolved root path, if any; null, if. none.

Throws:

KettleException

normalizeRootPath

@Nullable
protected String normalizeRootPath(@NonNull
 String rootPath)
                            throws KettleException

Throws:

KettleException

test

public <T extends VFSConnectionDetails> boolean test(@NonNull
 ConnectionManager manager,
 @NonNull
 T details,
 @Nullable
 VFSConnectionTestOptions options)
                                              throws KettleException

Tests if a VFS connection is valid, given its details, optionally, with certain testing options.

This method first delegates to ConnectionProvider.test(ConnectionDetails) to perform basic validation, independent of the connection's root path, VFSConnectionDetails.getRootPath(), if any, immediately returning false, when unsuccessful.

When base validation is successful, if options has a true VFSConnectionTestOptions.isRootPathIgnored(), this method should immediately return true.

Otherwise, the method should validate that the connection's root folder path is valid, taking into account the values of VFSConnectionDetails.isRootPathSupported(), VFSConnectionDetails.isRootPathRequired() and VFSConnectionDetails.getRootPath().

Parameters:

manager - The connection manager.

details - The details of the VFS connection to test.

options - The testing options, or null. When null, a default instance of VFSConnectionTestOptions is constructed and used.

Returns:

true if the connection is valid; false otherwise.

Throws:

KettleException

usesBuckets

public boolean usesBuckets(@NonNull
 VFSConnectionDetails details)
                    throws KettleException

Indicates if a VFS connection, given its details, uses buckets in its current configuration.

A VFS connection is using buckets if it can have buckets, as determined by VFSConnectionDetails.hasBuckets(), and if its resolved root path is null.

Parameters:

details - The VFS connection to check.

Returns:

true if a connection uses buckets; false otherwise.

Throws:

KettleException