jXchange Connector Technical Reference Doc

Enterprise SOAP API > jXchange Connector > jXchange Connector Technical Reference Doc

This is the main class of an extension, is the entry point from which configurations, connection providers, operations and sources are going to be declared.

Configurations

Config

The fundamental values within this configuration class for the extension are utilized in various operations.

Parameters

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	Connection	The connection types that can be provided to this configuration.	x
Name	String	The identifier of this element used to reference it in other components	x
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.	x

Connection Types

Connection

The Connection Provider class for the JHA extension.

Parameters

Name	Type	Description	Required
Service Gateway URL	String		x
Username	String		x
Password	String		x
Timeout	Number		x
Timeout unit	Enumeration, one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS		x
Proxy configuration	Proxy		x
TLS Configuration	TLS		x
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy	x

Associated Operations

Consume SOAP Service

Operations

Consume SOAP Service

jh-connector:consume-soap-service

Documentation | Jack Henry Enterprise Solutions | Jack Henry Docs Getting Started: Where do I get credentials? Sandbox - These would be sent via the Quick Start Guide upon joining the Vendor Integration Program. If you are not a member of the VIP, you can request temporary credentials from Enterprise. SOAP API | Jack Henry Enterprise Solutions | Jack Henry Docs Production - The Financial Institution must submit a case via the For Clients portal to request the jXchange credentials. Production credentials will only be granted to products that are an active member of the Vendor Integration Program (VIP).

Parameters

Name	Type	Description	Required
Configuration	String	The name of the configuration to use.	x
Config Ref	ConfigurationProvider	The name of the configuration to be used to execute this component	x
Streaming Strategy	Repeatable In memory stream Repeatable File Store Streamnon-repeatable-stream	Configure if repeatable streams should be used and their behaviour	x
Location	String		x
Container	String		x
Operation	String		x
Payload	Binary		x
Force MTOM	Boolean		x
Target Variable	String		x
Target Value	String		x
Reconnection Strategy	Reconnect Reconnect Forever		x

Output

Type - Any

For Configurations

Config

Throws

JH-CONNECTOR:CONNECTIVITY
JH-CONNECTOR:RETRY_EXHAUSTED

Types

Proxy

Field	Type	Required
Host	String	x
Port	Number	x
Username	String	x
Password	String	x
Non Proxy Hosts	String	x

Tls

Field	Type	Description	Required
Enabled Protocols	String	A comma separated list of protocols enabled for this context.	x
Enabled Cipher Suites	String	A comma separated list of cipher suites enabled for this context.	x
Trust Store	Trust Store		x
Key Store	Key Store		x
Revocation Check	Number	Standard Revocation Check Custom Ocsp Responder Crl File	x

Trust Store

Field	Type	Description	Required
Path	String	A comma separated list of protocols enabled for this context.	x
Type	String	The type of store used.	x
Alias	String	When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.	x
Key Password	String	The password used to protect the private key.	x
Password	String	The password used to protect the key store.	x
Algorithm	String	The algorithm used by the key store.	x

Key Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.
Type	String	The type of store used.
Alias	String	When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.
Key Password	String	The password used to protect the private key.
Password	String	The password used to protect the key store.
Algorithm	String	The algorithm used by the key store.

Standard Revocation Check

Field	Type	Description
Only End Entities	Boolean	Only verify the last element of the certificate chain.
Prefer Crls	Boolean	Try CRL instead of OCSP first.
No Fallback	Boolean	Do not use the secondary checking method (the one not selected before).
Soft Fail	Boolean	Avoid verification failure when the revocation server can not be reached or is busy.

Custom Ocsp Responder

Field	Type	Description	Default Value	Required
Url	String	The URL of the OCSP responder.
Cert Alias	String	Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Crl File

Field	Type	Description	Default Value	Required
Path	String	The path to the CRL file.

Reconnection

Field	Type	Description	Default Value	Required
Fails Deployment	Boolean	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy.
Reconnection Strategy	Reconnect Reconnnect Forever

Reconnect

Field	Type	Description
Frequency	Number	How often (in ms) to reconnect
Blocking	Boolean	If false, the reconnection strategy will run in a separate, non-blocking thread
Count	Number	How many reconnection attempts to make

Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often (in ms) to reconnect
Blocking	Boolean	If false, the reconnection strategy will run in a separate, non-blocking thread

Expriation Policy

Field	Type	Description	Default Value	Required
Max Idle Time	Number	A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.
Time Unit	Enumeration, one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS	A time unit that qualifies the maxIdleTime attribute

Repeatable In Memory Stream

Field	Type	Description
Initial Buffer Size	Number	This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.
Buffer Size Increment	Number	This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.
Max Buffer Size	Number	This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.
Buffer Unit	Enumeration, one of: BYTEKBMBGB	The unit in which all these attributes are expressed

Repeatable File Store Stream

Field	Type	Description	Default Value	Required
In Memory Size	Number	Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.
Buffer Unit	Enumeration, one of: BYTEKBMBGB	The unit in which maxInMemorySize is expressed.

Have a Question?

Have a how-to question? Seeing a weird error? Get help on StackOverflow.

Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.

Last updated Wed Nov 8 2023