SlaveServer (PDI Engine 9.0.0.1-426 API)

java.lang.Object
- org.pentaho.di.core.changed.ChangedFlag
- - org.pentaho.di.cluster.SlaveServer

All Implemented Interfaces:

Cloneable, ChangedFlagInterface, VariableSpace, XMLInterface, RepositoryElementInterface, RepositoryObjectInterface, SharedObjectInterface
```
public class SlaveServer
extends ChangedFlag
implements Cloneable, SharedObjectInterface, VariableSpace, RepositoryElementInterface, XMLInterface
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`KETTLE_CARTE_RETRIES`
`static int`	`KETTLE_CARTE_RETRY_BACKOFF_INCREMENTS`
`static RepositoryObjectType`	`REPOSITORY_ELEMENT_TYPE`
`static String`	`SSL_MODE_TAG`
`static String`	`STRING_SLAVESERVER`
`static String`	`XML_TAG`

Constructor Summary

Constructors
Constructor and Description
`SlaveServer()`
`SlaveServer(Node slaveNode)`
`SlaveServer(String name, String hostname, String port, String username, String password)`
`SlaveServer(String name, String hostname, String port, String username, String password, String proxyHostname, String proxyPort, String nonProxyHosts, boolean master)`
`SlaveServer(String name, String hostname, String port, String username, String password, String proxyHostname, String proxyPort, String nonProxyHosts, boolean master, boolean ssl)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`allocateServerSocket(String runId, int portRangeStart, String hostname, String transformationName, String sourceSlaveName, String sourceStepName, String sourceStepCopy, String targetSlaveName, String targetStepName, String targetStepCopy)`
`WebResult`	`cleanupTransformation(String transName, String carteObjectId)`
`Object`	`clone()`
`String`	`constructUrl(String serviceAndArguments)`
`void`	`copyVariablesFrom(VariableSpace space)`
`WebResult`	`deAllocateServerSockets(String transName, String clusteredRunId)`
`String`	`environmentSubstitute(String aString)`
`String[]`	`environmentSubstitute(String[] aString)`
`boolean`	`equals(Object obj)`
`String`	`execService(String service)`
`String`	`execService(String service, boolean retry)`
`String`	`execService(String service, Map<String,String> headerValues)`
`String`	`fieldSubstitute(String aString, RowMetaInterface rowMeta, Object[] rowData)`
`static SlaveServer`	`findSlaveServer(List<SlaveServer> slaveServers, ObjectId id)`
`static SlaveServer`	`findSlaveServer(List<SlaveServer> slaveServers, String name)`
`protected org.apache.http.client.protocol.HttpClientContext`	`getAuthContext()`
`static int`	`getBackoffIncrements()`
`boolean`	`getBooleanValueOfVariable(String variableName, boolean defaultValue)`
`Date`	`getChangedDate()`
`SlaveServer`	`getClient()`
`static long`	`getDelay(int trial)`
`String`	`getDescription()`
`String`	`getHostname()`
`SlaveServerJobStatus`	`getJobStatus(String jobName, String carteObjectId, int startLogLineNr)`
`Properties`	`getKettleProperties()`
`LogChannelInterface`	`getLogChannel()`
`String`	`getName()`
`long`	`getNextSlaveSequenceValue(String slaveSequenceName, long incrementValue)`
`String`	`getNonProxyHosts()`
`ObjectId`	`getObjectId()`
`ObjectRevision`	`getObjectRevision()`
`VariableSpace`	`getParentVariableSpace()`
`String`	`getPassword()`
`String`	`getPort()`
`String`	`getPortSpecification()`
`String`	`getPropertiesMasterName()`
`String`	`getProxyHostname()`
`String`	`getProxyPort()`
`RepositoryDirectoryInterface`	`getRepositoryDirectory()` Not used in this case, simply return root /
`RepositoryObjectType`	`getRepositoryElementType()`
`String`	`getServerAndPort()`
`List<SlaveServerDetection>`	`getSlaveServerDetections()`
`static String[]`	`getSlaveServerNames(List<SlaveServer> slaveServers)`
`SslConfiguration`	`getSslConfig()`
`SlaveServerStatus`	`getStatus()`
`SlaveServerTransStatus`	`getTransStatus(String transName, String carteObjectId, int startLogLineNr)`
`SlaveServerTransStatus`	`getTransStatus(String transName, String carteObjectId, int startLogLineNr, boolean sendResultXmlWithStatus)`
`String`	`getUsername()`
`String`	`getVariable(String variableName)`
`String`	`getVariable(String variableName, String defaultValue)`
`String`	`getWebAppName()`
`String`	`getXML()`
`int`	`hashCode()`
`void`	`initializeVariablesFrom(VariableSpace parent)`
`void`	`injectVariables(Map<String,String> prop)`
`boolean`	`isMaster()`
`boolean`	`isOverrideExistingProperties()`
`boolean`	`isShared()`
`boolean`	`isSslMode()`
`String[]`	`listVariables()`
`WebResult`	`pauseResumeTransformation(String transName, String carteObjectId)`
`WebResult`	`removeJob(String jobName, String carteObjectId)`
`WebResult`	`removeTransformation(String transName, String carteObjectId)`
`void`	`replaceMeta(SlaveServer slaveServer)`
`String`	`sendExport(String filename, String type, String load)` Send an exported archive over to this slave server
`String`	`sendXML(String xml, String service)`
`void`	`setDescription(String description)`
`void`	`setHostname(String urlString)`
`void`	`setMaster(boolean master)`
`void`	`setName(String name)`
`void`	`setNonProxyHosts(String nonProxyHosts)`
`void`	`setObjectId(ObjectId id)`
`void`	`setObjectRevision(ObjectRevision objectRevision)`
`void`	`setParentVariableSpace(VariableSpace parent)`
`void`	`setPassword(String password)`
`void`	`setPort(String port)`
`void`	`setProxyHostname(String proxyHostname)`
`void`	`setProxyPort(String proxyPort)`
`void`	`setRepositoryDirectory(RepositoryDirectoryInterface repositoryDirectory)`
`void`	`setShared(boolean shared)`
`void`	`setSslMode(boolean sslMode)`
`void`	`setUsername(String username)`
`void`	`setVariable(String variableName, String variableValue)`
`void`	`setWebAppName(String webAppName)`
`void`	`shareVariablesWith(VariableSpace space)`
`String`	`sniffStep(String transName, String stepName, String copyNr, int lines, String type)` Sniff rows on a the slave server, return xml containing the row metadata and data.
`WebResult`	`startJob(String jobName, String carteObjectId)`
`WebResult`	`startTransformation(String transName, String carteObjectId)`
`WebResult`	`stopJob(String transName, String carteObjectId)`
`WebResult`	`stopTransformation(String transName, String carteObjectId)`
`String`	`toString()`
`String`	`verifyAndModifySlaveServerName(List<SlaveServer> slaveServers, String oldname)` Verify the name of the slave server and if required, change it if it already exists in the list of slave servers.

Methods inherited from class org.pentaho.di.core.changed.ChangedFlag
addObserver, clearChanged, deleteObserver, hasChanged, notifyObservers, setChanged, setChanged

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

STRING_SLAVESERVER

public static final String STRING_SLAVESERVER

See Also:: Constant Field Values

XML_TAG
```
public static final String XML_TAG
```
See Also:

Constant Field Values

REPOSITORY_ELEMENT_TYPE

public static final RepositoryObjectType REPOSITORY_ELEMENT_TYPE

SSL_MODE_TAG

public static final String SSL_MODE_TAG

See Also:: Constant Field Values

KETTLE_CARTE_RETRIES

public static final int KETTLE_CARTE_RETRIES

KETTLE_CARTE_RETRY_BACKOFF_INCREMENTS

public static final int KETTLE_CARTE_RETRY_BACKOFF_INCREMENTS

Constructor Detail

SlaveServer
```
public SlaveServer()
```

SlaveServer

public SlaveServer(String name,
                   String hostname,
                   String port,
                   String username,
                   String password)

SlaveServer

public SlaveServer(String name,
                   String hostname,
                   String port,
                   String username,
                   String password,
                   String proxyHostname,
                   String proxyPort,
                   String nonProxyHosts,
                   boolean master)

SlaveServer

public SlaveServer(String name,
                   String hostname,
                   String port,
                   String username,
                   String password,
                   String proxyHostname,
                   String proxyPort,
                   String nonProxyHosts,
                   boolean master,
                   boolean ssl)

SlaveServer
```
public SlaveServer(Node slaveNode)
```

Method Detail

getBackoffIncrements

public static int getBackoffIncrements()

getLogChannel

public LogChannelInterface getLogChannel()

getXML
```
public String getXML()
```
Specified by:

getXML in interface XMLInterface

Specified by:

getXML in interface SharedObjectInterface

clone
```
public Object clone()
```
Overrides:

clone in class Object

replaceMeta

public void replaceMeta(SlaveServer slaveServer)

toString
```
public String toString()
```
Overrides:

toString in class Object

getServerAndPort
```
public String getServerAndPort()
```

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

getHostname
```
public String getHostname()
```

setHostname

public void setHostname(String urlString)

getPassword
```
public String getPassword()
```
Returns:

the password

setPassword
```
public void setPassword(String password)
```
Parameters:

password - the password to set

getUsername
```
public String getUsername()
```
Returns:

the username

setUsername
```
public void setUsername(String username)
```
Parameters:

username - the username to set

getWebAppName
```
public String getWebAppName()
```
Returns:

the username

setWebAppName
```
public void setWebAppName(String webAppName)
```
Parameters:

webAppName - the web application name to set

getNonProxyHosts
```
public String getNonProxyHosts()
```
Returns:

the nonProxyHosts

setNonProxyHosts
```
public void setNonProxyHosts(String nonProxyHosts)
```
Parameters:

nonProxyHosts - the nonProxyHosts to set

getProxyHostname
```
public String getProxyHostname()
```
Returns:

the proxyHostname

setProxyHostname
```
public void setProxyHostname(String proxyHostname)
```
Parameters:

proxyHostname - the proxyHostname to set

getProxyPort
```
public String getProxyPort()
```
Returns:

the proxyPort

setProxyPort
```
public void setProxyPort(String proxyPort)
```
Parameters:

proxyPort - the proxyPort to set

getPropertiesMasterName
```
public String getPropertiesMasterName()
```
Returns:

the Master name for read properties

isOverrideExistingProperties
```
public boolean isOverrideExistingProperties()
```
Returns:

flag for read properties from Master

getPort
```
public String getPort()
```
Returns:

the port

setPort
```
public void setPort(String port)
```
Parameters:

port - the port to set

getPortSpecification
```
public String getPortSpecification()
```

constructUrl

public String constructUrl(String serviceAndArguments)
                    throws UnsupportedEncodingException

Throws:: UnsupportedEncodingException

sendXML

public String sendXML(String xml,
                      String service)
               throws Exception

Throws:: Exception

sendExport
```
public String sendExport(String filename,
                         String type,
                         String load)
                  throws Exception
```
Send an exported archive over to this slave server

Parameters:

filename - The archive to send

type - The type of file to add to the slave server (AddExportServlet.TYPE_*)

load - The filename to load in the archive (the .kjb or .ktr)

Returns:

the XML of the web result

Throws:

Exception - in case something goes awry

getAuthContext

protected org.apache.http.client.protocol.HttpClientContext getAuthContext()

Returns:: HttpClientContext with authorization credentials

isMaster
```
public boolean isMaster()
```
Returns:

the master

setMaster
```
public void setMaster(boolean master)
```
Parameters:

master - the master to set

execService

public String execService(String service,
                          boolean retry)
                   throws Exception

Throws:: Exception

getDelay

public static long getDelay(int trial)

execService

public String execService(String service)
                   throws Exception

Throws:: Exception

execService

public String execService(String service,
                          Map<String,String> headerValues)
                   throws Exception

Throws:: Exception

getStatus

public SlaveServerStatus getStatus()
                            throws Exception

Throws:: Exception

getSlaveServerDetections

public List<SlaveServerDetection> getSlaveServerDetections()
                                                    throws Exception

Throws:: Exception

getTransStatus

public SlaveServerTransStatus getTransStatus(String transName,
                                             String carteObjectId,
                                             int startLogLineNr)
                                      throws Exception

Throws:: Exception

getTransStatus

public SlaveServerTransStatus getTransStatus(String transName,
                                             String carteObjectId,
                                             int startLogLineNr,
                                             boolean sendResultXmlWithStatus)
                                      throws Exception

Throws:: Exception

getJobStatus

public SlaveServerJobStatus getJobStatus(String jobName,
                                         String carteObjectId,
                                         int startLogLineNr)
                                  throws Exception

Throws:: Exception

stopTransformation

public WebResult stopTransformation(String transName,
                                    String carteObjectId)
                             throws Exception

Throws:: Exception

pauseResumeTransformation

public WebResult pauseResumeTransformation(String transName,
                                           String carteObjectId)
                                    throws Exception

Throws:: Exception

removeTransformation

public WebResult removeTransformation(String transName,
                                      String carteObjectId)
                               throws Exception

Throws:: Exception

removeJob

public WebResult removeJob(String jobName,
                           String carteObjectId)
                    throws Exception

Throws:: Exception

stopJob

public WebResult stopJob(String transName,
                         String carteObjectId)
                  throws Exception

Throws:: Exception

startTransformation

public WebResult startTransformation(String transName,
                                     String carteObjectId)
                              throws Exception

Throws:: Exception

startJob

public WebResult startJob(String jobName,
                          String carteObjectId)
                   throws Exception

Throws:: Exception

cleanupTransformation

public WebResult cleanupTransformation(String transName,
                                       String carteObjectId)
                                throws Exception

Throws:: Exception

deAllocateServerSockets

public WebResult deAllocateServerSockets(String transName,
                                         String clusteredRunId)
                                  throws Exception

Throws:: Exception

getKettleProperties

public Properties getKettleProperties()
                               throws Exception

Throws:: Exception

findSlaveServer

public static SlaveServer findSlaveServer(List<SlaveServer> slaveServers,
                                          String name)

findSlaveServer

public static SlaveServer findSlaveServer(List<SlaveServer> slaveServers,
                                          ObjectId id)

getSlaveServerNames

public static String[] getSlaveServerNames(List<SlaveServer> slaveServers)

allocateServerSocket

public int allocateServerSocket(String runId,
                                int portRangeStart,
                                String hostname,
                                String transformationName,
                                String sourceSlaveName,
                                String sourceStepName,
                                String sourceStepCopy,
                                String targetSlaveName,
                                String targetStepName,
                                String targetStepCopy)
                         throws Exception

Throws:: Exception

getName
```
public String getName()
```
Specified by:

getName in interface RepositoryElementInterface

Specified by:

getName in interface RepositoryObjectInterface

Specified by:

getName in interface SharedObjectInterface

setName
```
public void setName(String name)
```
Specified by:

setName in interface RepositoryElementInterface

isShared
```
public boolean isShared()
```
Specified by:

isShared in interface SharedObjectInterface

setShared
```
public void setShared(boolean shared)
```
Specified by:

setShared in interface SharedObjectInterface

copyVariablesFrom
```
public void copyVariablesFrom(VariableSpace space)
```
Specified by:

copyVariablesFrom in interface VariableSpace

environmentSubstitute
```
public String environmentSubstitute(String aString)
```
Specified by:

environmentSubstitute in interface VariableSpace

environmentSubstitute
```
public String[] environmentSubstitute(String[] aString)
```
Specified by:

environmentSubstitute in interface VariableSpace

fieldSubstitute

public String fieldSubstitute(String aString,
                              RowMetaInterface rowMeta,
                              Object[] rowData)
                       throws KettleValueException

Specified by:: fieldSubstitute in interface VariableSpace
Throws:: KettleValueException

getParentVariableSpace
```
public VariableSpace getParentVariableSpace()
```
Specified by:

getParentVariableSpace in interface VariableSpace

setParentVariableSpace
```
public void setParentVariableSpace(VariableSpace parent)
```
Specified by:

setParentVariableSpace in interface VariableSpace

getVariable

public String getVariable(String variableName,
                          String defaultValue)

Specified by:: getVariable in interface VariableSpace

getVariable
```
public String getVariable(String variableName)
```
Specified by:

getVariable in interface VariableSpace

getBooleanValueOfVariable

public boolean getBooleanValueOfVariable(String variableName,
                                         boolean defaultValue)

Specified by:: getBooleanValueOfVariable in interface VariableSpace

initializeVariablesFrom
```
public void initializeVariablesFrom(VariableSpace parent)
```
Specified by:

initializeVariablesFrom in interface VariableSpace

listVariables
```
public String[] listVariables()
```
Specified by:

listVariables in interface VariableSpace

setVariable

public void setVariable(String variableName,
                        String variableValue)

Specified by:: setVariable in interface VariableSpace

shareVariablesWith
```
public void shareVariablesWith(VariableSpace space)
```
Specified by:

shareVariablesWith in interface VariableSpace

injectVariables
```
public void injectVariables(Map<String,String> prop)
```
Specified by:

injectVariables in interface VariableSpace

getObjectId
```
public ObjectId getObjectId()
```
Specified by:

getObjectId in interface RepositoryElementInterface

Specified by:

getObjectId in interface RepositoryObjectInterface

setObjectId
```
public void setObjectId(ObjectId id)
```
Specified by:

setObjectId in interface RepositoryElementInterface

getRepositoryDirectory
```
public RepositoryDirectoryInterface getRepositoryDirectory()
```
Not used in this case, simply return root /

Specified by:

getRepositoryDirectory in interface RepositoryElementInterface

setRepositoryDirectory
```
public void setRepositoryDirectory(RepositoryDirectoryInterface repositoryDirectory)
```
Specified by:

setRepositoryDirectory in interface RepositoryElementInterface

getRepositoryElementType
```
public RepositoryObjectType getRepositoryElementType()
```
Specified by:

getRepositoryElementType in interface RepositoryElementInterface

getObjectRevision
```
public ObjectRevision getObjectRevision()
```
Specified by:

getObjectRevision in interface RepositoryElementInterface

setObjectRevision
```
public void setObjectRevision(ObjectRevision objectRevision)
```
Specified by:

setObjectRevision in interface RepositoryElementInterface

getDescription
```
public String getDescription()
```
Specified by:

getDescription in interface RepositoryElementInterface

setDescription
```
public void setDescription(String description)
```
Specified by:

setDescription in interface RepositoryElementInterface

verifyAndModifySlaveServerName
```
public String verifyAndModifySlaveServerName(List<SlaveServer> slaveServers,
                                             String oldname)
```
Verify the name of the slave server and if required, change it if it already exists in the list of slave servers.

Parameters:

slaveServers - the slave servers to check against.

oldname - the old name of the slave server

Returns:

the new slave server name

sniffStep

public String sniffStep(String transName,
                        String stepName,
                        String copyNr,
                        int lines,
                        String type)
                 throws Exception

Sniff rows on a the slave server, return xml containing the row metadata and data.

Parameters:: transName - transformation name; stepName - step name; copyNr - step copy number; lines - lines number; type - step type
Returns:: xml with row metadata and data
Throws:: Exception

getNextSlaveSequenceValue

public long getNextSlaveSequenceValue(String slaveSequenceName,
                                      long incrementValue)
                               throws KettleException

Throws:: KettleException

getClient
```
public SlaveServer getClient()
```

getChangedDate
```
public Date getChangedDate()
```
Specified by:

getChangedDate in interface SharedObjectInterface

Returns:

the changedDate

setSslMode

public void setSslMode(boolean sslMode)

Parameters:: sslMode -

isSslMode
```
public boolean isSslMode()
```
Returns:

the sslMode

getSslConfig

public SslConfiguration getSslConfig()

Returns:: the sslConfig

Class SlaveServer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.pentaho.di.core.changed.ChangedFlag

Methods inherited from class java.lang.Object

Field Detail

STRING_SLAVESERVER

XML_TAG

REPOSITORY_ELEMENT_TYPE

SSL_MODE_TAG

KETTLE_CARTE_RETRIES

KETTLE_CARTE_RETRY_BACKOFF_INCREMENTS

Constructor Detail

SlaveServer

SlaveServer

SlaveServer

SlaveServer

SlaveServer

Method Detail

getBackoffIncrements

getLogChannel

getXML

clone

replaceMeta

toString

getServerAndPort

equals

hashCode

getHostname

setHostname

getPassword

setPassword

getUsername

setUsername

getWebAppName

setWebAppName

getNonProxyHosts

setNonProxyHosts

getProxyHostname

setProxyHostname

getProxyPort

setProxyPort

getPropertiesMasterName

isOverrideExistingProperties

getPort

setPort

getPortSpecification

constructUrl

sendXML

sendExport

getAuthContext

isMaster

setMaster

execService

getDelay

execService

execService

getStatus

getSlaveServerDetections

getTransStatus

getTransStatus

getJobStatus

stopTransformation

pauseResumeTransformation

removeTransformation

removeJob

stopJob

startTransformation

startJob

cleanupTransformation

deAllocateServerSockets

getKettleProperties

findSlaveServer

findSlaveServer

getSlaveServerNames

allocateServerSocket

getName

setName

isShared