SiteToSiteClientConfig (nifi-site-to-site-client 1.23.2 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

SiteToSiteClient.StandardSiteToSiteClientConfig
```
public interface SiteToSiteClientConfig
extends Serializable
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`long`	`getCacheExpiration(TimeUnit unit)` When the contents of a remote NiFi instance are fetched, that information is cached so that many calls that are made in a short period of time do not overwhelm the remote NiFi instance.
`EventReporter`	`getEventReporter()`
`HttpProxy`	`getHttpProxy()` Return Proxy for HTTP Transport Protocol.
`long`	`getIdleConnectionExpiration(TimeUnit timeUnit)`
`String`	`getKeystoreFilename()`
`String`	`getKeystorePassword()`
`KeystoreType`	`getKeystoreType()`
`InetAddress`	`getLocalAddress()`
`PeerPersistence`	`getPeerPersistence()`
`File`	`getPeerPersistenceFile()`
`long`	`getPenalizationPeriod(TimeUnit timeUnit)`
`String`	`getPortIdentifier()`
`String`	`getPortName()`
`int`	`getPreferredBatchCount()` When pulling data from a NiFi instance, the sender chooses how large a Transaction is.
`long`	`getPreferredBatchDuration(TimeUnit timeUnit)` When pulling data from a NiFi instance, the sender chooses how large a Transaction is.
`long`	`getPreferredBatchSize()` When pulling data from a NiFi instance, the sender chooses how large a Transaction is.
`SSLContext`	`getSslContext()`
`StateManager`	`getStateManager()`
`long`	`getTimeout(TimeUnit timeUnit)`
`SiteToSiteTransportProtocol`	`getTransportProtocol()`
`String`	`getTruststoreFilename()`
`String`	`getTruststorePassword()`
`KeystoreType`	`getTruststoreType()`
`String`	`getUrl()` Deprecated. This method only returns single URL string even if multiple URLs are set for backward compatibility for implementations that does not expect multiple URLs. `getUrls()` should be used instead then should support multiple URLs when making requests.
`Set<String>`	`getUrls()` SiteToSite implementations should support multiple URLs when establishing a SiteToSite connection with a remote NiFi instance to provide robust connectivity so that it can keep working as long as at least one of the configured URLs is accessible.
`boolean`	`isUseCompression()`

- Method Detail
  - getUrl
```
@Deprecated
String getUrl()
```
    Deprecated. This method only returns single URL string even if multiple URLs are set for backward compatibility for implementations that does not expect multiple URLs. getUrls() should be used instead then should support multiple URLs when making requests.
    
    Returns:
    
    the configured URL for the remote NiFi instance
  - getUrls
```
Set<String> getUrls()
```
    SiteToSite implementations should support multiple URLs when establishing a SiteToSite connection with a remote NiFi instance to provide robust connectivity so that it can keep working as long as at least one of the configured URLs is accessible.
    
    Returns:
    
    the configured URLs for the remote NiFi instances.
  - getTimeout
```
long getTimeout(TimeUnit timeUnit)
```
    Parameters:
    
    timeUnit - unit over which to report the timeout
    
    Returns:
    
    the communications timeout in given unit
  - getIdleConnectionExpiration
```
long getIdleConnectionExpiration(TimeUnit timeUnit)
```
    Parameters:
    
    timeUnit - the unit for which to report the time
    
    Returns:
    
    the amount of time that a connection can remain idle before it is "expired" and shut down
  - getPenalizationPeriod
```
long getPenalizationPeriod(TimeUnit timeUnit)
```
    Parameters:
    
    timeUnit - unit over which to report the time
    
    Returns:
    
    the amount of time that a particular node will be ignored after a communications error with that node occurs
  - getSslContext
```
SSLContext getSslContext()
```
    Returns:
    
    the SSL Context that is configured for this builder
    
    Throws:
    
    IllegalStateException - if an SSLContext is being constructed and an error occurs doing so
  - getKeystoreFilename
```
String getKeystoreFilename()
```
    Returns:
    
    the filename to use for the keystore, or null if none is configured
  - getKeystorePassword
```
String getKeystorePassword()
```
    Returns:
    
    the password to use for the keystore, or null if none is configured
  - getKeystoreType
```
KeystoreType getKeystoreType()
```
    Returns:
    
    the Type of the keystore, or null if none is configured
  - getTruststoreFilename
```
String getTruststoreFilename()
```
    Returns:
    
    the filename to use for the truststore, or null if none is configured
  - getTruststorePassword
```
String getTruststorePassword()
```
    Returns:
    
    the password to use for the truststore, or null if none is configured
  - getTruststoreType
```
KeystoreType getTruststoreType()
```
    Returns:
    
    the type of the truststore, or null if none is configured
  - getPeerPersistenceFile
```
File getPeerPersistenceFile()
```
    Returns:
    
    the file that is to be used for persisting the nodes of a remote cluster, if any
  - getStateManager
```
StateManager getStateManager()
```
    Returns:
    
    the StateManager to be used for persisting the nodes of a remote
  - getPeerPersistence
```
PeerPersistence getPeerPersistence()
```
    Returns:
    
    a PeerPersistence implementation based on configured persistent target
  - isUseCompression
```
boolean isUseCompression()
```
    Returns:
    
    a boolean indicating whether or not compression will be used to transfer data to and from the remote instance
  - getTransportProtocol
```
SiteToSiteTransportProtocol getTransportProtocol()
```
    Returns:
    
    a transport protocol to use
  - getPortName
```
String getPortName()
```
    Returns:
    
    the name of the port that the client is to communicate with
  - getPortIdentifier
```
String getPortIdentifier()
```
    Returns:
    
    the identifier of the port that the client is to communicate with
  - getPreferredBatchDuration
```
long getPreferredBatchDuration(TimeUnit timeUnit)
```
    When pulling data from a NiFi instance, the sender chooses how large a Transaction is. However, the client has the ability to request a particular batch size/duration.
    
    Parameters:
    
    timeUnit - unit of time over which to report the duration
    
    Returns:
    
    the maximum amount of time that we will request a NiFi instance to send data to us in a Transaction
  - getPreferredBatchSize
```
long getPreferredBatchSize()
```
    When pulling data from a NiFi instance, the sender chooses how large a Transaction is. However, the client has the ability to request a particular batch size/duration.
    
    Returns:
    
    returns the maximum number of bytes that we will request a NiFi instance to send data to us in a Transaction
  - getPreferredBatchCount
```
int getPreferredBatchCount()
```
    When pulling data from a NiFi instance, the sender chooses how large a Transaction is. However, the client has the ability to request a particular batch size/duration.
    
    Returns:
    
    the maximum number of DataPackets that we will request a NiFi instance to send data to us in a Transaction
  - getCacheExpiration
```
long getCacheExpiration(TimeUnit unit)
```
    When the contents of a remote NiFi instance are fetched, that information is cached so that many calls that are made in a short period of time do not overwhelm the remote NiFi instance. This method will indicate the number of milliseconds that this information can be cached.
    
    Parameters:
    
    unit - the desired time unit
    
    Returns:
    
    the number of milliseconds that the contents of a remote NiFi instance will be cached
  - getEventReporter
```
EventReporter getEventReporter()
```
    Returns:
    
    the EventReporter that is to be used by clients to report events
  - getHttpProxy
```
HttpProxy getHttpProxy()
```
    Return Proxy for HTTP Transport Protocol.
    
    Returns:
    
    proxy or null if not specified
  - getLocalAddress
```
InetAddress getLocalAddress()
```
    Returns:
    
    the InetAddress to bind to for the local address when creating a socket, or null to bind to the anyLocal address.

Interface SiteToSiteClientConfig

Method Summary

Method Detail

getUrl

getUrls

getTimeout

getIdleConnectionExpiration

getPenalizationPeriod

getSslContext

getKeystoreFilename

getKeystorePassword

getKeystoreType

getTruststoreFilename

getTruststorePassword

getTruststoreType

getPeerPersistenceFile

getStateManager

getPeerPersistence

isUseCompression

getTransportProtocol

getPortName

getPortIdentifier

getPreferredBatchDuration

getPreferredBatchSize

getPreferredBatchCount

getCacheExpiration

getEventReporter

getHttpProxy

getLocalAddress