com.gooddata.connector

Class SfdcConnector

java.lang.Object

com.gooddata.connector.AbstractConnector

com.gooddata.connector.SfdcConnector

All Implemented Interfaces:

Connector, Executor

public class SfdcConnector
extends AbstractConnector
implements Connector

GoodData SFDC Connector

Version:

1.0

Author:

zd

Field Summary

Fields inherited from class com.gooddata.connector.AbstractConnector

DATE_LENGTH_UNRESTRICTED, projectId, schema

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SfdcConnector() Creates a new SFDC connector

Method Summary

Modifier and Type	Method and Description
protected static SoapBindingStub	connect(String host, String usr, String psw, String token, String clientID) Connect the SFDC
static SfdcConnector	createConnector() Creates a new SFDC connector
protected static Map<String,Field>	describeObject(SoapBindingStub c, String name) Retrieves the object's metadata
protected static SObject	executeQueryFirstRow(SoapBindingStub binding, String sfdcQuery, String clientID) Executes the SFDC query, returns one row only.
void	extract(String file, boolean transform) Extract rows
String	getClientID()
protected static String	getColumnType(Map<String,Field> fields, String fieldName) Derives the LDM type from the SFDC type
String	getSfdcHostname()
String	getSfdcPassword() SFDC password getter
String	getSfdcQuery() SFDC query getter
String	getSfdcToken() SFDC security token getter
String	getSfdcUsername() SFDC username getter
boolean	processCommand(Command c, CliParams cli, ProcessingContext ctx) Processes single command
static void	saveConfigTemplate(String name, String configFileName, String sfdcHostname, String sfdcUsr, String sfdcPsw, String sfdcToken, String partnerId, String query) Saves a template of the config file
void	setClientID(String clientID)
void	setSfdcHostname(String sfdcHostname)
void	setSfdcPassword(String sfdcPassword) SFDC password setter
void	setSfdcQuery(String sfdcQuery) SFDC query setter
void	setSfdcToken(String sfdcToken) SFDC security token setter
void	setSfdcUsername(String sfdcUsername) SFDC username setter

Methods inherited from class com.gooddata.connector.AbstractConnector

checkLoadingStatus, copyAndTransform, deploy, dump, dumpData, expandDates, extract, extractAndTransfer, generateMaqlCreate, getProjectId, getResult, getSchema, initSchema, populateColumnsFromSchema, setIncremental, setProjectId, setProjectId, setSchema, transferData

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gooddata.connector.Connector

deploy, dump, extract, extractAndTransfer, generateMaqlCreate, getSchema, setSchema

Constructor Detail

SfdcConnector

protected SfdcConnector()

Creates a new SFDC connector

Method Detail

createConnector

public static SfdcConnector createConnector()

Creates a new SFDC connector

Returns:

a new instance of the SFDC connector

executeQueryFirstRow

protected static SObject executeQueryFirstRow(SoapBindingStub binding,
                                              String sfdcQuery,
                                              String clientID)
                                       throws SfdcException

Executes the SFDC query, returns one row only. This is useful for metadata inspection purposes

Parameters:

binding - SFDC stub

sfdcQuery - SFDC SOOL query

clientID - SFDC partner client ID

Returns:

results as List of SObjects

Throws:

SfdcException - in case of SFDC communication errors

describeObject

protected static Map<String,Field> describeObject(SoapBindingStub c,
                                                  String name)
                                           throws RemoteException

Retrieves the object's metadata

Parameters:

c - SFDC stub

name - SFDC object name

Returns:

Map of fields

Throws:

RemoteException - communication error

saveConfigTemplate

public static void saveConfigTemplate(String name,
                                      String configFileName,
                                      String sfdcHostname,
                                      String sfdcUsr,
                                      String sfdcPsw,
                                      String sfdcToken,
                                      String partnerId,
                                      String query)
                               throws IOException

Saves a template of the config file

Parameters:

name - new schema name

configFileName - config file name

sfdcUsr - SFDC username

sfdcPsw - SFDC password

sfdcToken - SFDC security token

query - SFDC query

partnerId - SFDC partner ID

Throws:

IOException - if there is a problem with writing the config file

getColumnType

protected static String getColumnType(Map<String,Field> fields,
                                      String fieldName)

Derives the LDM type from the SFDC type

Parameters:

fields - SFDC object metadata

fieldName - the field name

Returns:

LDM type

extract

public void extract(String file,
                    boolean transform)
             throws IOException

Extract rows

Specified by:

extract in class AbstractConnector

Parameters:

file - name of the target file

transform - perform transformations

Throws:

IOException

connect

protected static SoapBindingStub connect(String host,
                                         String usr,
                                         String psw,
                                         String token,
                                         String clientID)
                                  throws SfdcException

Connect the SFDC

Parameters:

usr - SFDC username

psw - SFDC pasword

token - SFDC security token

Returns:

SFDC stub

Throws:

SfdcException - in case of connection issues

getSfdcUsername

public String getSfdcUsername()

SFDC username getter

Returns:

SFDC username

setSfdcUsername

public void setSfdcUsername(String sfdcUsername)

SFDC username setter

Parameters:

sfdcUsername - SFDC username

getSfdcPassword

public String getSfdcPassword()

SFDC password getter

Returns:

SFDC password

setSfdcPassword

public void setSfdcPassword(String sfdcPassword)

SFDC password setter

Parameters:

sfdcPassword - SFDC password

getSfdcQuery

public String getSfdcQuery()

SFDC query getter

Returns:

SFDC query

setSfdcQuery

public void setSfdcQuery(String sfdcQuery)

SFDC query setter

Parameters:

sfdcQuery - SFDC query

getSfdcToken

public String getSfdcToken()

SFDC security token getter

Returns:

SFDC security token

setSfdcToken

public void setSfdcToken(String sfdcToken)

SFDC security token setter

Parameters:

sfdcToken - SFDC security token

getSfdcHostname

public String getSfdcHostname()

Returns:

the sfdcHostname

setSfdcHostname

public void setSfdcHostname(String sfdcHostname)

Parameters:

sfdcHostname - the sfdcHostname to set

getClientID

public String getClientID()

setClientID

public void setClientID(String clientID)

processCommand

public boolean processCommand(Command c,
                              CliParams cli,
                              ProcessingContext ctx)
                       throws ProcessingException

Processes single command

Specified by:

processCommand in interface Executor

Overrides:

processCommand in class AbstractConnector

Parameters:

c - command to be processed

cli - parameters (commandline params)

ctx - processing context

Returns:

true if the command has been processed, false otherwise

Throws:

ProcessingException - in case of issues during the command processing