Package org.pentaho.di.shared

Class VfsSharedObjectsIO

java.lang.Object

org.pentaho.di.shared.VfsSharedObjectsIO

All Implemented Interfaces:

SharedObjectsIO

public class VfsSharedObjectsIO
extends Object
implements SharedObjectsIO

Provide methods to retrieve and save the shared objects defined in shared.xml that is stored in file system.

Nested Class Summary

Nested classes/interfaces inherited from interface org.pentaho.di.shared.SharedObjectsIO

SharedObjectsIO.SharedObjectType

Constructor Summary

Constructors

Constructor	Description
VfsSharedObjectsIO()	Creates the instance of VfsSharedObjectsIO using the default location of the shared file.
VfsSharedObjectsIO(String rootFolder, Bowl bowl)	Creates the instance of VfsSharedObjectsIO using the rootFolder.

Method Summary

Modifier and Type	Method	Description
void	clear(String type)	Remove all the connections of a given type.
void	clearCache()	Clear any cached objects in the SharedObjectsIO
void	delete(String type, String name)	Delete the SharedObject for the given type and name.
Node	getSharedObject(String type, String name)	Return the node for the given SharedObject type and name.
Map<String,Node>	getSharedObjects(String type)	Return the Map of names and the corresponding nodes for the given shared object type.
void	lock()	Lock the SharedObjectsIO for exclusive access.
protected void	restoreFileFromBackup(String backupFileName)
void	saveSharedObject(String type, String name, Node node)	Save the name and the node for the given Shared Object Type in the file.
protected void	saveToFile()
protected String	toString(Map<String,Node> nodesMap)
void	unlock()	Unlock the SharedObjectsIO after exclusive access is no longer needed.
protected void	writeToFile(org.apache.commons.vfs2.FileObject fileObject, Optional<String> backupFileName)

Methods inherited from class java.lang.Object

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

Constructor Details

VfsSharedObjectsIO

public VfsSharedObjectsIO()

Creates the instance of VfsSharedObjectsIO using the default location of the shared file.

VfsSharedObjectsIO

public VfsSharedObjectsIO(String rootFolder,
 Bowl bowl)

Creates the instance of VfsSharedObjectsIO using the rootFolder.

Parameters:

rootFolder - the root folder containing the shared object file.

Method Details

getSharedObjects

public Map<String,Node> getSharedObjects(String type)
                                  throws KettleXMLException

Return the Map of names and the corresponding nodes for the given shared object type. The parsing of shared.xml happens when this method is called.

Specified by:

getSharedObjects in interface SharedObjectsIO

Parameters:

type -

Returns:

Mapinvalid input: '<'String, Node>

Throws:

KettleXMLException

clearCache

public void clearCache()

Description copied from interface: SharedObjectsIO

Clear any cached objects in the SharedObjectsIO

Specified by:

clearCache in interface SharedObjectsIO

saveSharedObject

public void saveSharedObject(String type,
 String name,
 Node node)
                      throws KettleException

Save the name and the node for the given Shared Object Type in the file. If the SharedObject name exist but in a different case, the existing entry will be deleted and the new entry will be saved with provided name

Specified by:

saveSharedObject in interface SharedObjectsIO

Parameters:

type - The SharedObject type

name - The name of the SharedObject for a given type

node - The xml node that containing the details of the SharedObject

Throws:

KettleException

saveToFile

protected void saveToFile()
                   throws KettleException

Throws:

KettleException

writeToFile

protected void writeToFile(org.apache.commons.vfs2.FileObject fileObject,
 Optional<String> backupFileName)
                    throws IOException,
KettleException

Throws:

IOException

KettleException

restoreFileFromBackup

protected void restoreFileFromBackup(String backupFileName)
                              throws IOException,
KettleFileException

Throws:

IOException

KettleFileException

getSharedObject

public Node getSharedObject(String type,
 String name)
                     throws KettleException

Return the node for the given SharedObject type and name. The lookup for the SharedObject using the name will be case-insensitive

Specified by:

getSharedObject in interface SharedObjectsIO

Parameters:

type - The type is shared object type for example, "connection", "slaveserver", "partitionschema" and clusterschema"

name - The name is the name of the sharedObject

Returns:

Throws:

KettleXMLException

KettleException

delete

public void delete(String type,
 String name)
            throws KettleException

Delete the SharedObject for the given type and name. The delete operation will be case-insensitive.

Specified by:

delete in interface SharedObjectsIO

Parameters:

type - The type is shared object type for example, "connection", "slaveserver", "partitionschema" and clusterschema"

name - The name is the name of the sharedObject

Throws:

KettleException

clear

public void clear(String type)
           throws KettleException

Description copied from interface: SharedObjectsIO

Remove all the connections of a given type.

Specified by:

clear in interface SharedObjectsIO

Parameters:

type - Type to clear

Throws:

KettleException

lock

public void lock()

Description copied from interface: SharedObjectsIO

Lock the SharedObjectsIO for exclusive access. This lock should be held while interacting with any Node objects returned by this SharedObjectsIO.

Specified by:

lock in interface SharedObjectsIO

unlock

public void unlock()

Description copied from interface: SharedObjectsIO

Unlock the SharedObjectsIO after exclusive access is no longer needed.

Specified by:

unlock in interface SharedObjectsIO

toString

protected String toString(Map<String,Node> nodesMap)
                   throws KettleXMLException

Throws:

KettleXMLException