ConnectorConfig (force-wsc 31.0.0 API)

java.lang.Object
- com.sforce.ws.ConnectorConfig

```
public class ConnectorConfig
extends Object
```
This class contains a set of configuration properties

Since:

1.0 Dec 19, 2005

Version:

1.0

Author:

http://cheenath.com

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ConnectorConfig.TeeInputStream

class ConnectorConfig.TeeOutputStream

Nested Classes
Modifier and Type	Class and Description
`class`	`ConnectorConfig.TeeInputStream`
`class`	`ConnectorConfig.TeeOutputStream`

Field Summary

Fields
Modifier and Type Field and Description

static ConnectorConfig DEFAULT

Fields
Modifier and Type	Field and Description
`static ConnectorConfig`	`DEFAULT`

Constructor Summary

Constructors
Constructor and Description

ConnectorConfig()

Constructors
Constructor and Description
`ConnectorConfig()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMessageHandler(MessageHandler handler)`
`void`	`clearMessageHandlers()`
`HttpURLConnection`	`createConnection(URL url, HashMap<String,String> httpHeaders)`
`HttpURLConnection`	`createConnection(URL url, HashMap<String,String> httpHeaders, boolean enableCompression)`
`Transport`	`createTransport()`
`String`	`getAuthEndpoint()`
`int`	`getConnectionTimeout()`
`Map<String,String>`	`getHeaders()`
`int`	`getMaxRequestSize()`
`int`	`getMaxResponseSize()`
`Iterator<MessageHandler>`	`getMessagerHandlers()`
`String`	`getNtlmDomain()`
`String`	`getPassword()`
`Proxy`	`getProxy()`
`String`	`getProxyPassword()`
`String`	`getProxyUsername()`
`int`	`getReadTimeout()`
`String`	`getRequestHeader(String key)`
`String`	`getRestEndpoint()`
`String`	`getServiceEndpoint()`
`String`	`getSessionId()`
`SessionRenewer`	`getSessionRenewer()`
`String`	`getTraceFile()`
`PrintStream`	`getTraceStream()`
`Class`	`getTransport()`
`String`	`getUsername()`
`boolean`	`hasMessageHandlers()`
`boolean`	`isCompression()`
`boolean`	`isManualLogin()`
`boolean`	`isPrettyPrintXml()`
`boolean`	`isTraceMessage()`
`boolean`	`isValidateSchema()`
`void`	`setAuthEndpoint(String authEndpoint)`
`void`	`setCompression(boolean compress)`
`void`	`setConnectionTimeout(int connectionTimeout)` sets connection timeout
`void`	`setManualLogin(boolean manualLogin)`
`void`	`setMaxRequestSize(int maxRequestSize)`
`void`	`setMaxResponseSize(int maxResponseSize)`
`void`	`setNtlmDomain(String domain)`
`void`	`setPassword(String password)`
`void`	`setPrettyPrintXml(boolean prettyPrintXml)`
`void`	`setProxy(Proxy proxy)`
`void`	`setProxy(String host, int port)`
`void`	`setProxyPassword(String proxyPassword)`
`void`	`setProxyUsername(String proxyUsername)`
`void`	`setReadTimeout(int readTimeout)` sets read timeout
`void`	`setRequestHeader(String key, String value)`
`void`	`setRestEndpoint(String restEndpoint)`
`void`	`setServiceEndpoint(String serviceEndpoint)`
`void`	`setSessionId(String sessionId)`
`void`	`setSessionRenewer(SessionRenewer sessionRenewer)`
`void`	`setTraceFile(String traceFile)`
`void`	`setTraceMessage(boolean traceMessage)` prints request and response xml message on console
`void`	`setTransport(Class transport)`
`void`	`setUseChunkedPost(boolean chunk)`
`void`	`setUsername(String username)`
`void`	`setValidateSchema(boolean validateSchema)`
`void`	`teeInputStream(byte[] bytes)`
`OutputStream`	`teeOutputStream(OutputStream os)`
`boolean`	`useChunkedPost()`
`void`	`verifyEnterpriseEndpoint()`
`void`	`verifyPartnerEndpoint()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

public static final ConnectorConfig DEFAULT

Constructor Detail
- ConnectorConfig
```
public ConnectorConfig()
```

Method Detail

getTransport
```
public Class getTransport()
```

setTransport

public void setTransport(Class transport)

setNtlmDomain

public void setNtlmDomain(String domain)

getNtlmDomain
```
public String getNtlmDomain()
```

isValidateSchema
```
public boolean isValidateSchema()
```

setValidateSchema

public void setValidateSchema(boolean validateSchema)

setProxy

public void setProxy(String host,
            int port)

setProxy
```
public void setProxy(Proxy proxy)
```

getProxy
```
public Proxy getProxy()
```

getHeaders

public Map<String,String> getHeaders()

getRequestHeader

public String getRequestHeader(String key)

setRequestHeader

public void setRequestHeader(String key,
                    String value)

getProxyUsername
```
public String getProxyUsername()
```

setProxyUsername

public void setProxyUsername(String proxyUsername)

getProxyPassword
```
public String getProxyPassword()
```

setProxyPassword

public void setProxyPassword(String proxyPassword)

isPrettyPrintXml
```
public boolean isPrettyPrintXml()
```

setPrettyPrintXml

public void setPrettyPrintXml(boolean prettyPrintXml)

getUsername
```
public String getUsername()
```

setUsername

public void setUsername(String username)

getPassword
```
public String getPassword()
```

setPassword

public void setPassword(String password)

getSessionId
```
public String getSessionId()
```

setSessionId

public void setSessionId(String sessionId)

getServiceEndpoint
```
public String getServiceEndpoint()
```

setServiceEndpoint

public void setServiceEndpoint(String serviceEndpoint)

isCompression
```
public boolean isCompression()
```

setCompression

public void setCompression(boolean compress)

getReadTimeout
```
public int getReadTimeout()
```

setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
sets read timeout

Parameters:
readTimeout - timeout in ms

getConnectionTimeout
```
public int getConnectionTimeout()
```

setConnectionTimeout
```
public void setConnectionTimeout(int connectionTimeout)
```
sets connection timeout

Parameters:
connectionTimeout - timout in ms

isTraceMessage
```
public boolean isTraceMessage()
```

setTraceMessage
```
public void setTraceMessage(boolean traceMessage)
```
prints request and response xml message on console

Parameters:
traceMessage - true to print message

getTraceFile
```
public String getTraceFile()
```

setTraceFile

public void setTraceFile(String traceFile)
                  throws FileNotFoundException

Throws:: FileNotFoundException

getTraceStream
```
public PrintStream getTraceStream()
```

getAuthEndpoint
```
public String getAuthEndpoint()
```

setAuthEndpoint

public void setAuthEndpoint(String authEndpoint)

setManualLogin

public void setManualLogin(boolean manualLogin)

isManualLogin
```
public boolean isManualLogin()
```

setUseChunkedPost

public void setUseChunkedPost(boolean chunk)

useChunkedPost
```
public boolean useChunkedPost()
```

verifyPartnerEndpoint

public void verifyPartnerEndpoint()
                           throws ConnectionException

Throws:: ConnectionException

verifyEnterpriseEndpoint

public void verifyEnterpriseEndpoint()
                              throws ConnectionException

Throws:: ConnectionException

getMessagerHandlers

public Iterator<MessageHandler> getMessagerHandlers()

hasMessageHandlers
```
public boolean hasMessageHandlers()
```

addMessageHandler

public void addMessageHandler(MessageHandler handler)

clearMessageHandlers
```
public void clearMessageHandlers()
```

getMaxRequestSize
```
public int getMaxRequestSize()
```

setMaxRequestSize

public void setMaxRequestSize(int maxRequestSize)

getMaxResponseSize
```
public int getMaxResponseSize()
```

setMaxResponseSize

public void setMaxResponseSize(int maxResponseSize)

getRestEndpoint
```
public String getRestEndpoint()
```

setRestEndpoint

public void setRestEndpoint(String restEndpoint)

getSessionRenewer

public SessionRenewer getSessionRenewer()

setSessionRenewer

public void setSessionRenewer(SessionRenewer sessionRenewer)

createTransport

public Transport createTransport()
                          throws ConnectionException

Throws:: ConnectionException

createConnection

public HttpURLConnection createConnection(URL url,
                                 HashMap<String,String> httpHeaders)
                                   throws IOException

Throws:: IOException

teeInputStream

public void teeInputStream(byte[] bytes)

teeOutputStream

public OutputStream teeOutputStream(OutputStream os)

createConnection

public HttpURLConnection createConnection(URL url,
                                 HashMap<String,String> httpHeaders,
                                 boolean enableCompression)
                                   throws IOException

Throws:: IOException

Class ConnectorConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT

Constructor Detail

ConnectorConfig

Method Detail

getTransport

setTransport

setNtlmDomain

getNtlmDomain

isValidateSchema

setValidateSchema

setProxy

setProxy

getProxy

getHeaders

getRequestHeader

setRequestHeader

getProxyUsername

setProxyUsername

getProxyPassword

setProxyPassword

isPrettyPrintXml

setPrettyPrintXml

getUsername

setUsername

getPassword

setPassword

getSessionId

setSessionId

getServiceEndpoint

setServiceEndpoint

isCompression

setCompression

getReadTimeout

setReadTimeout

getConnectionTimeout

setConnectionTimeout

isTraceMessage

setTraceMessage

getTraceFile

setTraceFile

getTraceStream

getAuthEndpoint

setAuthEndpoint

setManualLogin

isManualLogin

setUseChunkedPost

useChunkedPost

verifyPartnerEndpoint

verifyEnterpriseEndpoint

getMessagerHandlers

hasMessageHandlers

addMessageHandler

clearMessageHandlers

getMaxRequestSize

setMaxRequestSize

getMaxResponseSize

setMaxResponseSize

getRestEndpoint

setRestEndpoint

getSessionRenewer

setSessionRenewer

createTransport

createConnection

teeInputStream

teeOutputStream

createConnection