Advanced Configuration

Obsidian requires some initial configuration parameters for database connection information and desired authentication mechanisms. The installer ant targets take care of detailing these. For your reference should you wish to manually create/edit these, note the details below.

Configuration Details

# Comment out the native authenticator setup
#com.carfey.suite.security.Authenticator=com.carfey.suite.security.DBAuthenticator

#Set your LDAP info here
com.carfey.suite.security.Authenticator=com.carfey.suite.security.LdapAuthenticator
com.carfey.suite.security.LdapAuthenticator.dn.base=ou=people,o=MyOrgHere
com.carfey.suite.security.LdapAuthenticator.url=ldap://localhost:10389

# Configure who may access the web app, based on LDAP group membership
com.carfey.suite.security.LdapAuthenticator.accessDN=cn=SchedulerAccess,ou=groups,o=MyOrgHere

# Configure the Write role used in the admin web app, based on LDAP group membership (by default, users may only read)
com.carfey.suite.security.LdapAuthenticator.role.write.dn=cn=SchedulerWrite,ou=groups,o=MyOrgHere
# No need to alter this
com.carfey.suite.security.LdapAuthenticator.role.write.roleName=Write

# Configure the Admin role used in the admin web app, based on LDAP group membership (users may configure system parameters, etc).
com.carfey.suite.security.LdapAuthenticator.role.admin.dn=cn=SchedulerAdmin,ou=groups,o=MyOrgHere
# No need to alter this
com.carfey.suite.security.LdapAuthenticator.role.admin.roleName=Admin

# Configure the LimitedRead role used in the admin web app, based on LDAP group membership (by default, users may only read)
com.carfey.suite.security.LdapAuthenticator.role.limitedRead.dn=cn=SchedulerLimitedRead,ou=groups,o=MyOrgHere
# No need to alter this
com.carfey.suite.security.LdapAuthenticator.role.limitedRead.roleName=LimitedRead

# Configure the APIrole used by the REST API, based on LDAP group membership
com.carfey.suite.security.LdapAuthenticator.role.api.dn=cn=SchedulerAPI,ou=groups,o=MyOrgHere
# No need to alter this
com.carfey.suite.security.LdapAuthenticator.role.api.roleName=API

# Email configuration for notifications, if desired
#for straight up open relay, just specify the host using
mail.smtp.host=smtp.myopenrelayhost.com
mail.smtp.port=port 
#(standard ports are 25, 465 for SSL, 587 for TLS)

#for using TLS and SSL, provide these as necessary
mail.smtp.socketFactory.port=port
mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
mail.smtp.auth=true
[email protected]
mail.smtp.password=PASSWORD


# Database configuration
com.carfey.obsidian.db.url=jdbc:mysql://localhost/obsidian
com.carfey.obsidian.db.userId=user
com.carfey.obsidian.db.password=pass

# Table prefix may be used to add a prefix to tables and related database objects. It must be 6 or fewer characters and can contain letters or underscores.
com.carfey.obsidian.db.tablePrefix=OBSDN_

# For Oracle databases, when Obsidian's tables exist in a different schema from the user specified above, specify the target schema here. Available as of version 2.1.
com.carfey.obsidian.db.schema=obsidian

com.carfey.obsidian.db.maxConnections=50
#default max connections per pool if not specified is 50

com.carfey.obsidian.db.connectionTimeout=2000
#default millis timeout to retrieve available connection from pool if not specified is 2000

Notifications Configuration

Notifications require the above smtp configuration to send emails to subscribers. Default values are provided under the Dispatch category of System and can be set accordingly.

Properties File

The above configuration must reside in a properties file named com.carfey.properties found according to the rules of ClassLoader.getResource. Some possibilities include WEB-INF/classes/com.carfey.properties, a com.carfey.properties file in a directory with that directory explicitly added to the classpath or inside a jar as is done in obsidian-props.jar for standalone deployments.

As of Obsidian 1.5, to make use of our external property file override support, use the System property carfey.properties.file. Between the default properties and the override, all expected properties must be specified. Any properties found in both files will use the override file's values. Usage: -Dcarfey.properties.file=/home/obsidian/obsidian.properties.

Dependent Libraries

Obsidian Scheduler requires a number of third party libraries, both for the web administration application and the scheduler itself. Below is information on these libraries and how they are used. Unless otherwise noted, they are mandatory.

• activation-1.1.jar, mail-1.4.jar, smtp.jar. Used for email notifications.
• carfey-date-1.1.jar. Date math/manipulation.
• dom4j-1.6.1.jar. XML utilities.
• obsidian-gen.jar, obsidian.jar, jdk-gen.jar, jdk.jar, suite-gen.jar, suite.jar. Core Obsidian libs.
• log4j-1.2.9.jar. Obsidian logging uses log4j.
• gson-2.2.2.jar (gson-1.5.jar before 1.5). Supports REST API and web administration.
• cos.jar, jstl.jar, standard.jar. Web utilities. Only required in web administration.
• bsh-2.0b4.jar. Support for our Bean Shell script execution. (http://www.beanshell.org). Only required for BeanShellJob usage.
• groovy-all-1.7.6.jar. Support for Groovy script execution (http://groovy.codehaus.org). Only required for GroovyJob usage.
• jython.jar. Support for Python script execution (http://www.jython.org). Only required for PythonJob usage.
• jmustache-1.8.jar (2.0 and later). Provides email templating.
• jtds-1.2.jar. SQLServer jdbc driver. Only required for running SQLServer.
• mysql-connector-java-5.1.6-bin.jar. MySQL jdbc driver. Only required for running MySQL.
• h2-1.3.154. H2 database and jdbc driver. Only required for running H2.
• ojdbc14.jar. Oracle jdbc driver. Only required for running Oracle.
• postgresql-9.0-801.jdbc4.jar. PostgreSQL jdbc driver. Only required for running PostgreSQL.