ConnectPlazaAgent Properties
ConnectAgent configuration
This chapter will inform you about the configuration options in the connectplaza-agent.properties file.
As you download the ConnectAgent from Deploy you will get a preconfigured ConnectAgent. As you set some values before downloading the ConnectAgent. These values will be injected into serveral .properties files.
In the properties file you see a # for the line, this line is a default value. Only remove the # if you want to change a specific value.
The connectplaza-agent.properties file looks like this:
# moved to defaults in applicationContext.xml (to change default value, uncomment and change value)
#connect.mbean.server.connector.url=service:jmx:jmxmp://localhost:9876
#connect.mbean.defaultdomain=com.opdion.myesb
#connect.mbean.connectdomain=com.opdion.myesb.connect.management
#connect.mbean.sidomain=com.opdion.myesb.si
#connect.mbean.componentindex.asattribute=false
#connect.mbean.componentindex.inname=true
#connect.activemq.broker.uri=vm://localhost
#connect.activemq.broker.persistent=true
# allocated memoryspace
#connect.activemq.broker.systemusage.memoryusage=64mb
# 10gb disk space for persistent messages in kahadb
#connect.activemq.broker.systemusage.storeusage=10gb
# 2gb disk space, used for swapping non-persistent messages when memory full
#connect.activemq.broker.systemusage.tempusage=2gb
#connect.amqp.host=localhost
#connect.amqp.port=5672
#connect.amqp.username=guest
#connect.amqp.password=guest
#connect.network.interfacename=eth0
#connect.jetty.connector.host=0.0.0.0
#connect.jetty.connector.port=8088
#connect.jetty.connector.maxidletime=30000
#connect.jetty.connector.acceptors=2
#connect.jetty.connector.confidentialport=8443
#connect.jetty.sslconnector.host=0.0.0.0
#connect.jetty.sslconnector.port=8443
#connect.jetty.sslconnector.included.protocols=TLSv1,TLSv1.1,TLSv1.2
#connect.jetty.sslconnector.maxidletime=30000
#connect.jetty.sslconnector.acceptors=2
#connect.jetty.sslconnector.keystore=./context/connectpaza_keystore.jks
#connect.jetty.sslconnector.keystore.password=<set>
#connect.jetty.sslconnector.truststore=./context/connectplaza_truststore.jks
#connect.jetty.sslconnector.truststore.password=<set>
# taskexecutor runs pollable consumers
#connect.taskexecutor.poolsize=5-40
#connect.taskexecutor.queue.capacity=20000
# taskscheduler runs services and producers
#connect.taskscheduler.poolsize=50
#connect.globalpoller.fixed-delay=50 // poller will poll next queue after this time ( or repeatedly all queues after this time?)
#connect.globalpoller.receive-timeout=500 // poller thread will wait this time for message to arrive on polled queue, after that thread will return to pool
# // so with delay of 50 and timeout of 500 10 threads will be continue in use
#connect.license.owner=dummy
#connect.license.key=0000-0000-0000-0000
#connect.license.cloud=true
#connect.cloudserver.uri=https://backend.connectplaza.com:443
#connect.adapters.donotstart=
#connect.http.proxyHost=
#connect.http.proxyPort=
#connect.http.proxyUser=
#connect.http.proxyPassword=
#connect.https.proxyHost=
#connect.https.proxyPort=
#connect.https.proxyUser=
#connect.https.proxyPassword=
# connection factory used by the jmsconsumer of the analyzechannel for receiving analyze messages from other jms implementations (like sonic or mule)
# defaults to the default connectionfactory set by connect.connectionfactory.name
# CHANGE ONLY!! when you want analyze to use a different connection factory than your default connection factory
#connect.analyze.connectionfactory=connectionFactory
# name of the queue which the jmsconsumer of the analyzechannel will use to receive analyze messages
#connect.analyze.queue=queue.analyze
#connect.analyze.concurrent.consumers=1
#connect.analyze.concurrent.max.consumers=5
# default jms connectionfactory defined in agent
#connect.connectionfactory.name=activeMQFactory
# Enable loading of CA certificates
connect.ssl.ca.truststore=true
# default timeout in seconds for large File Support
#connect.lfs.timeout=3600
# Either SQL or MONGO
connect.analyze.storagetype=SQL
connect.adapter.myesbcommon.storechannel.storedirectory=./temp/storechannel
connect.adapter.myesbcommon.mailchannel.smtp.host=test
connect.adapter.myesbcommon.mailchannel.smtp.port=25
connect.adapter.myesbcommon.mailchannel.smtp.username=test
connect.adapter.myesbcommon.mailchannel.smtp.password=test
connect.adapter.myesbcommon.mailchannel.smtp.to=test
connect.adapter.myesbcommon.mailchannel.smtp.from=test
connect.adapter.myesbcommon.mailchannel.smtp.subject=Exception Report
connect.adapter.myesbcommon.mailchannel.smtp.starttls=false
connect.adapter.myesbcommon.mailchannel.smtp.maildebug=false
#Properties written by ConnectPlaza Download
#Fri Mar 02 10:54:35 CET 2018
connect.mbean.server.connector.url=service\:jmx\:jmxmp\://10.1.0.184\:9876
connect.jetty.sslconnector.host=10.1.0.184
connect.license.key=XXXX-19YX-XXXX-JS2V-5XXT
connect.jetty.connector.host=10.1.0.184
connect.cloudserver.uri=https\://test.connectplaza.com\:8443
connect.jetty.sslconnector.port=8443
connect.jetty.connector.port=8088
Explanation of the parameters
| Parameter | Default Value | Description |
| connect.mbean.server.connector.url | service:jmx:jmxmp://localhost:9876 | This is the connection to the JAVA JMX server. |
| connect.mbean.defaultdomain | com.opdion.myesb | |
| connect.mbean.connectdomain | com.opdion.myesb.connect.management | |
| connect.mbean.sidomain | com.opdion.myesb.si | |
| connect.mbean.componentindex.asattribute | false | |
| connect.mbean.componentindex.inname | true | |
| connect.activemq.broker.uri | vm://localhost | Default ActiveMQ broker URI |
| connect.activemq.broker.persistent | true | Is the ActiveMQ broker persistent or not (true or false) |
| connect.activemq.broker.systemusage.memoryusage | 64mb | Allocated memoryspace for the broker |
| connect.activemq.broker.systemusage.storeusage | 10gb | 10gb Disk space for persistent messages in kahadb |
| connect.activemq.broker.systemusage.tempusage | 2gb | 2gb Disk space, used for swapping non-persistent messages when memory full |
| connect.amqp.host | localhost | ActiveMQ Host |
| connect.amqp.port | 5672 | ActiveMQ port number on the selected host |
| connect.amqp.username | guest | ActiveMQ user name to log in |
| connect.amqp.password | guest | ActiveMQ password for the user to log in |
| connect.network.interfacename | eth0 | |
| connect.jetty.connector.host | 0.0.0.0 | ConnectPlaza Agent non SSL binding hostname. Default binds to 0.0.0.0 is the whole network. |
| connect.jetty.connector.port | 8088 | ConnectPlaza Agent port number for non SSL bindings |
| connect.jetty.connector.maxidletime | 30000 | |
| connect.jetty.connector.acceptors | 2 | Number of acceptors of the ConnectPlaza Agent |
| connect.jetty.connector.confidentialport | 8443 | |
| connect.jetty.sslconnector.host | 0.0.0.0 | ConnectPlaza Agent SSL binding hostname. Default binds to 0.0.0.0 is the whole network. |
| connect.jetty.sslconnector.port | 8443 | ConnectPlaza Agent port number for SSL bindings |
| connect.jetty.sslconnector.included.protocols | TLSv1,TLSv1.1,TLSv1.2 |
ConnectPlaza Agent SSL supported protocols. |
| connect.jetty.sslconnector.included.ciphers | Empty by default |
Here you can add the ciphers in case you need an old, not default supported, cipher suite. |
| connect.jetty.sslconnector.maxidletime | 30000 | |
| connect.jetty.sslconnector.acceptors | 2 | Number of acceptors of the ConnectPlaza Agent |
| connect.jetty.sslconnector.keystore | ./context/connectpaza_keystore.jks | The keystore for the ConnectPlaza Agents. You can access the keystore via Deploy to add / remove your own certificates. Restart of the ConnectAgent is required after modifying the keystore. |
| connect.jetty.sslconnector.keystore.password | <set> | Password of the keystore. This is for ConnectPlaza personel only |
| connect.jetty.sslconnector.truststore | ./context/connectplaza_truststore.jks | The truststore for the ConnectPlaza Agents. You can access the truststore via Deploy to add / remove your own certificates. Restart of the ConnectAgent is required after modifying the truststore. |
| connect.jetty.sslconnector.truststore.password | <set> | Password of the truststore. This is for ConnectPlaza personel only |
| connect.taskexecutor.poolsize | 5-40 | taskexecutor runs pollable consumers |
| connect.taskexecutor.queue.capacity | 20000 | taskscheduler runs services and producers |
| connect.taskscheduler.poolsize | 50 | Total number of taskschedulers for the ConnectPlaza Agent. If you experience a lot of latency or connection problems (Deploy timeouts for instance), it is probably a good idea to add more taskschedulers |
| connect.globalpoller.fixed-delay | 50 | poller will poll next queue after this time ( or repeatedly all queues after this time?) |
| connect.globalpoller.receive-timeout | 500 | poller thread will wait this time for message to arrive on polled queue, after that thread will return to pool so with delay of 50 and timeout of 500 10 threads will be continue in use |
| connect.license.owner | dummy | |
| connect.license.key | 0000-0000-0000-0000 | Your ConnectPlaza license key |
| connect.license.cloud | true |
True if you are a Cloud user False if you are not connected to the cloud. If you are not connected to the cloud you need a license file. You can get this license file from ConnectPlaza. Please contact your account manager in order to find out if you need this kind of license. |
| connect.cloudserver.uri | https://backend.connectplaza.com:443 | |
| connect.adapters.donotstart | <empty> | This value can contain a comma separated string with all the interfaces from the adapters directory, you do not want to load at ConnectAgent startup time. |
| connect.http.proxyHost | <empty> | The proxy host name (non SSL) |
| connect.http.proxyPort | <empty> | The proxy port number (non SSL) |
| connect.http.proxyUser | <empty> | The proxy user login name (non SSL) |
| connect.http.proxyPassword | <empty> | The proxy user password (non SSL) |
| connect.https.proxyHost | <empty> | The proxy host name SSL |
| connect.https.proxyPort | <empty> | The proxy port number SSL |
| connect.https.proxyUser | <empty> | The proxy user login name SSL |
| connect.https.proxyPassword | The proxy user password SSL | |
| connect.analyze.connectionfactory | connectionFactory |
connection factory used by the jmsconsumer of the analyzechannel for receiving analyze messages from other jms implementations (like sonic or mule) Defaults to the default connectionfactory set by connect.connectionfactory.name !!CHANGE ONLY!! when you want analyze to use a different connection factory than your default connection factory |
| connect.analyze.queue | queue.analyze | Name of the queue which the jmsconsumer of the analyzechannel will use to receive analyze messages |
| JSM Consumer threads | Maximum number of JMS consumer threads of the internal Analyze Channel. This is relevant is you are reading messages from third party sources (queues) like Sonic. | |
| connect.analyze.concurrent.consumers | 1 | Minimum number of JMS consumer threads of the internal Analyze Channel. This is relevant is you are reading messages from third party sources (queues) like Sonic. |
| connect.analyze.concurrent.max.consumers | 5 | |
| connect.connectionfactory.name | activeMQFactory | default jms connectionfactory defined in agent |
| connect.ssl.ca.truststore | true | Enable loading of CA certificates (true or false |
| connect.lfs.timeout=3600 | 3600 | default timeout in seconds for large File Support |
| connect.analyze.storagetype | SQL | Either SQL or MONGO |
| connect.adapter.myesbcommon.storechannel.storedirectory | ./temp/storechannel | |
| connect.adapter.myesbcommon.mailchannel.smtp.host | test | Hostname of the SMTP server. Value is mandatory, no # before the line may exist. |
| connect.adapter.myesbcommon.mailchannel.smtp.port | 25 | Port number of the SMTP server. Value is mandatory, no # before the line may exist. |
| connect.adapter.myesbcommon.mailchannel.smtp.username | test | User name to log in into the SMTP server. Value is mandatory, no # before the line may exist. |
| connect.adapter.myesbcommon.mailchannel.smtp.password | test | Passowrd of the user logging in into the SMTP server. Value is mandatory, no # before the line may exist. |
| connect.adapter.myesbcommon.mailchannel.smtp.to | test | To address of the eMail. Value is mandatory, no # before the line may exist. |
| connect.adapter.myesbcommon.mailchannel.smtp.from | test | Fron address of the eMail. Value is mandatory, no # before the line may exist. |
| connect.adapter.myesbcommon.mailchannel.smtp.subject | Exception Report | Subject of the eMail. Value is mandatory, no # before the line may exist. |
| connect.adapter.myesbcommon.mailchannel.smtp.starttls | false | SMTP Server uses TLS (true or false). Value is mandatory, no # before the line may exist. |
| connect.adapter.myesbcommon.mailchannel.smtp.maildebug | false | Set debug option (true or false). Value is mandatory, no # before the line may exist. |
When you download the agent the next parameters are written to the configuration before downloading the agent.
| Parameter | Value | Description |
| connect.mbean.server.connector.url | service\:jmx\:jmxmp\://10.1.0.184\:9876 | This is the connection to the JAVA JMX server. |
| connect.jetty.sslconnector.host | 10.1.0.184 | This is the hostname or IP of the SSL Server of the agent. This is where the ConnectAgent binds to when using SSL connections |
| connect.license.key | XXXX-19YX-XXXX-JS2V-5XXT | This is the license code of you ConnectAgent. Every agent has its own licensekey. |
| connect.jetty.connector.host | 10.1.0.184 | This is the hostname or IP of the Server of the agent. This is where the ConnectAgent binds to if using non SSL connections |
| connect.cloudserver.uri | https\://www.connectplaza.com\:8443 | This is the connection to the cloudserver your updates are stored. Only change this if told by a ConnectPlaza consultant. |
| connect.jetty.sslconnector.port | 8443 | Port number of the SSL connection to the ConnectAgent |
| connect.jetty.connector.port | 8088 | Port number of the non-SSL connection to the ConnectAgent |