Plugin:org.tolven.appserverproperties

From DOC

Contents 1 Overview 2 Command Line 2.1 Display the current server properties 2.2 Load the default server properties contained in this plugin 2.3 Set a server property 2.4 Remove a server property 2.5 Start the server properties GUI 3 AppServer Properties Manager GUI 3.1 Standalone GUI 3.2 Component Of AppServer Manager GUI 4 Version 2.1 Notes 4.1 Version 2.1.3 4.2 Version 2.1.2 4.3 Version 2.1.1 4.4 Version 2.1.0 5 Version 2 Notes 5.1 Version 2.0.16 5.2 Version 2.0.15 5.3 Version 2.0.15 5.4 Version 2.0.14 5.5 Version 2.0.12 5.6 Version 2.0.11 5.7 Version 2.0.10 6 Version Notes 6.1 Version 0.0.11 6.2 Version 0.0.10 6.3 Version 0.0.9 6.4 Version 0.0.6 6.5 Version 0.0.5 6.6 Version 0.0.4 6.7 Version 0.0.3 6.8 Version 0.0.2 6.9 Version 0.0.1

Overview

Command Line

Display the current server properties

tpf -plugin org.tolven.appserverproperties -display

Load the default server properties contained in this plugin

tpf -plugin org.tolven.appserverproperties -load

The default server properties in the contained server-default-config.properties.xml are:

<properties>
	<entry key="mail.debug">false</entry>
	<entry key="mail.smtp.auth">true</entry>
	<entry key="mail.smtp.host">smtp.mydomain.com</entry>
	<entry key="mail.smtp.starttls.enable">true</entry>
	<entry key="mail.transport.protocol">smtp</entry>
	<entry key="tolven.timezone">America/Los_Angeles</entry>
	<entry key="tolven.repository.oid">1.2</entry>
	<entry key="tolven.login.create.demoUser">true</entry>
	<entry key="tolven.login.create.activatedUser">true</entry>
	<entry key="tolven.register.referenceRequired">false</entry>
	<entry key="tolven.register.expiration">3600</entry>
	<entry key="tolven.notice.uri">/notice.xhtml</entry>
	<entry key="tolven.mail.from">notify@mydomain.com</entry>
	<entry key="tolven.mail.fromName">My Organization</entry>
	<entry key="tolven.mail.user">notify@mydomain.com</entry>
	<entry key="tolven.mail.password">mypassword</entry>
	<entry key="tolven.invitation.host">mydomain.com</entry>
	<entry key="tolven.invitation.port">8080</entry>
	<entry key="tolven.invitation.root">/Tolven</entry>
	<entry key="tolven.invitation.replyTo">http://mydomain.com:8080/Tolven</entry>
	<entry key="tolven.ldap.baseDN">ou=people,dc=tolven,dc=com</entry>
	<entry key="tolven.ldap.deleteUser">false</entry>
	<entry key="tolven.gen.patient.max">1000</entry>
	<entry key="tolven.web.defaultLogo">/images/lazye.png</entry>
	<entry key="tolven.web.javascript.debug">false</entry>
	<entry key="tolven.web.showMore">true</entry>
	<entry key="tolven.web.cvNextCheck">8</entry>
	<entry key="tolven.web.cvLongest">64</entry>
	<entry key="tolven.web.cvBlank">600</entry>
	<entry key="tolven.web.cvLogout">660</entry>
	<entry key="tolven.performance.stats">true</entry>
	<entry key="webserver.http.portRedirect">8443</entry>
	<entry key="tolven.security.user.privateKeyLength">1024</entry>
	<entry key="tolven.security.user.privateKeyAlgorithm">RSA</entry>
	<entry key="tolven.security.user.passwordIterationCount">20</entry>
	<entry key="tolven.security.user.passwordSaltLength">8</entry>
	<entry key="tolven.security.user.pbeKeyAlgorithm">PBEWithMD5AndDES</entry>
	<entry key="tolven.security.account.privateKeyAlgorithm">RSA</entry>
	<entry key="tolven.security.account.keyLength">1024</entry>
	<entry key="tolven.security.accountUser.kbeKeyAlgorithm">DESede</entry>
	<entry key="tolven.security.accountUser.kbeKeyLength">112</entry>
	<entry key="tolven.security.doc.kbeKeyAlgorithm">DESede</entry>
	<entry key="tolven.security.doc.kbeKeyLength">112</entry>
	<entry key="tolven.security.doc.signatureAlgorithm">SHA1withRSA</entry>
</properties>

The default server properties are located by editing the following plugin property located in the <config-dir>/plugins.xml:

<plugin id="org.tolven.appserverproperties">
	<root />
	<property name="appserver.default.propertiesFile" value="server-default-config.properties.xml" />
</plugin>

Since the value represents a relative path, it will lead to the file within the plugin. If an absolute path is defined, then that location will be loaded instead.

Set a server property

tpf -plugin org.tolven.appserverproperties -set myPropertyName myPropertyValue

Note that if myPropertyValue contains spaces, then you must surround the value with quotes.

Remove a server property

tpf -plugin org.tolven.appserverproperties -remove myPropertyName

Start the server properties GUI

tpf -plugin org.tolven.appserverproperties -gui

See: AppServer Properties GUI

AppServer Properties Manager GUI

Standalone GUI

Component Of AppServer Manager GUI

GUI components like this one can be a component of a parent GUI. To make this plugin's GUI a child of org.tolven.appservermgr, ensure that the following property appears in this plugin's entry in the <config-dir>/plugins.xml:

<plugin id="org.tolven.appserverproperties">
	<root />
	<property name="guiComponentParentId" value="org.tolven.appservermgr" />
</plugin>

org.tolven.appservermgr must also be in the <config-dir>/plugins.xml as a <root> plugin, so that it can be referenced.

Version 2.1 Notes

Version 2.1.3

• Changed the following default appserverproperties:
  • <entry key="tolven.security.session.kbeKeyAlgorithm">AES</entry>
  • <entry key="tolven.security.session.kbeKeyLength">128</entry>

Version 2.1.2

• Removed @ManagedBean because the new version of Jersey causes issues with injection. This was seen originally in JBoss, and is now seen in Glassfish as well.

Version 2.1.1

• Removed references to org.tolven.library.pluginframework.gui.

Version 2.1.0

• This plug-in was updated to provide non-functional changes that were made to accommodate Tolven's release build process:

Version 2 Notes

Version 2.0.16

1. Added a new property tolven.security.user.keysOptional [true | false] (defaulted to false).
2. When false, users cannot create Accounts unless they have userPKCS12 and userCertificate in LDAP.
3. When false, users cannot invite other users to Accounts unless those users have userPKCS12 and userCertificate in LDAP.
4. The property is useful for development environments, but keeping it false is still recommended for testing

Version 2.0.15

1. If no properties are sent in the request to set properties, return a http status 400

Version 2.0.15

1. Added tolven.web.createAccount to the default appserverproperties

Version 2.0.14

1. Removed JUnit tests since these are system tests

Version 2.0.12

1. Added JUnit tests

Version 2.0.11

1. Changed HttpStatus code checks in Jersey, from >=400 to != 200 for responses known to only be OK

Version 2.0.10

1. Query params are now sent along with XML bodies, rather than using path params

Version Notes

Version 0.0.11

The XML01 column in the MenuData entity/table contains an XML representation of extended columns stored in a placeholder. The XML is stored as a LOB and managed by a class called org.tolven.app.entity.ExtendedMenuData. A new feature in this plug-in update allows this XML to be encrypted. Encryption is controlled by a new Tolven property named org.tolven.app.encrypt.xml01 with a value of true or false. If the property is not present, then XML01 is stored un-encrypted. This is to maintain backward compatibility.

Prior to this update, the XML was stored in plain text and should remain readable as such. In fact, regardless of the setting of the property described above, the data must remain readable. To accomplish this, encrypted XML01 content is now signified by a non-null secret key field (see below) that indicates that it is encrypted. An existing installation that has not set the property should not see any change to the values in the XML01 column.

When the value of the XML01 field is modified in any way, the new property will determine if the field should be encrypted or not. If true, it should be encrypted. Any other value, including null, means to not encrypt (and ensure that the new secretKey field is also null). When reading the XML01 field, if the secret key field is non-null, then decrypt, otherwise, process the field as plaintext.

The org.tolven.app.encrypt.xml01 property is set in the file server-default-config.properties, which is part of the org.tolven.appserverproperties plug-in. This plug-in, when executed using the tpf command (tpf -plugin org.tolven.appserverproperties -load), loads the properties from this file. These properties are accessible from within the Tolven application.

See also org.tolven.component.tolvenejb.

Version 0.0.10

Superseded by Version 0.0.11.

Version 0.0.9

Version 0.0.9 of the org.tolven.appserverproperties plug-in was released. An issue with this version of the plug-in was reported. The plug-in will be re-released at version 0.0.10. Watch this wiki page for the update.

Version 0.0.6

1. Added an option to display appserver properties
2. Added an option to remove appserver properties
3. Ensure that beginTransaction/commitTransaction is only called once during the execution of options
4. Added exception handlers to clarify failed rollbacks

Version 0.0.5

1. Added exception handlers to clarify failed rollbacks

Version 0.0.4

1. Added an option to display appserver properties
2. Added an option to remove appserver properties
3. Ensure that beginTransaction/commitTransaction is only called once during the execution of options

Version 0.0.3

1. tolvenRemoteClient is now assembled during configPhase1, and placed in the public/download directory of the /Tolven context, where it can be automatically downloaded from the server via http to the installDir/remoteLib directory for use during the execution of configPhase3

Version 0.0.2

Fixed the help syntax for setting a property

Version 0.0.1

Replacement for org.tolven.assembler.appserverproperties, which incorporates GUI functionality as well as the command line. Please also remove org.tolven.config.appserverproperties as a <root> plugin in the <config-dir>/plugins.xml file. If using version 0.0.1 of the Tolven kit, then the corresponding org.tolven.assembler.appserverproperties plugin will automatically be removed from repositoryRuntime too. Previous versions of the kit, will require users to either remove this plugin by hand, or take the safe route, and remove all repositoryRuntime plugins and re-populate the runtime.