Note

title	Version Warning

The content below is for Apache Syncope <= 1.2 - for later versions check the "System Administration" chapter of the Reference Guide.

Table of Contents

style	decimal

Introduction

Once you have created your project, you can start adapting it to your own needs and requirements.

Deployment directory

Currently, Syncope needs two three base directories to be defined:

bundles - where ConnId bundles are stored (check what a connector bundle is);
log - where all system logs are written;
conf (optional) - where configuration files are located, if override is needed.

Warning

Bundles directory should only contain connector bundle JAR files.

The presence of any other file might cause the unavailability of any connector bundle in Apache Syncope.

For example, you can create directories as follows:

Code Block
$ mkdir /opt/syncope $ mkdir /opt/syncope/bundles $ mkdir /opt/syncope/log $ mkdir /opt/syncope/conf

Internal storage

Internal storage is a database where all information and configurations are stored.

...

as indicated in the following.

PostgreSQL

Code Block


jpa.driverClassName=org.postgresql.Driver
jpa.url=jdbc:postgresql://localhost:5432/syncope
jpa.username=syncope
jpa.password=syncope
jpa.dialect=org.apache.openjpa.jdbc.sql.PostgresDictionary
jpa.pool.validationQuery=SELECT 1
#note: other connection pool settings can also be configured here, see persistenceContext.xml
quartz.jobstore=org.quartz.impl.jdbcjobstore.PostgreSQLDelegate
quartz.sql=tables_postgres.sql
logbackaudit.sql=postgresqlaudit.sql
database.schema=

This assumes that you have a PostgreSQL instance running on localhost, listening on its default port 5432 with a database

...

syncope

...

fully accessible by user

...

syncope

...

with password

...

syncope.

MySQL

Code Block


jpa.driverClassName=com.mysql.jdbc.Driver
jpa.url=jdbc:mysql://localhost:3306/syncope?characterEncoding=UTF-8
jpa.username=syncope
jpa.password=syncope
jpa.dialect=org.apache.openjpa.jdbc.sql.MySQLDictionary
jpa.pool.validationQuery=SELECT 1
#note: other connection pool settings can also be configured here, see persistenceContext.xml
quartz.jobstore=org.quartz.impl.jdbcjobstore.StdJDBCDelegate
quartz.sql=tables_mysql_innodb.sql
logbackaudit.sql=audit_mysql_innodb.sql
database.schema=

This assumes that you have a MySQL instance running on localhost, listening on its default port 3306 with a database

...

syncope

...

fully accessible by user

Code Block
syncope

with password

...

syncope with password syncope.

It also assumes that the InnoDB engine is enabled in your MySQL instance - if this is not the case, then change the value for 'quartz.sql' to

Code Block
quartz.sql=tables_mysql.sql

MariaDB

Code Block

jpa.driverClassName=org.mariadb.jdbc.Driver
jpa.url=jdbc:mariadb://localhost:3306/syncope?characterEncoding=UTF-8
jpa.username=syncope
jpa.password=syncope
jpa.dialect=org.apache.openjpa.jdbc.sql.MariaDBDictionary
jpa.pool.validationQuery=SELECT 1
#note: other connection pool settings can also be configured here, see persistenceContext.xml
quartz.jobstore=org.quartz.impl.jdbcjobstore.StdJDBCDelegate
quartz.sql=tables_mariadb.sql
audit.sql=audit.sql
database.schema=

This assumes that you have a MariaDB instance running on localhost, listening on its default port 3306 with a database syncope fully accessible by user syncope with password syncope.

Oracle

Code Block


jpa.driverClassName=oracle.jdbc.OracleDriver
jpa.url=jdbc:oracle:thin:@localhost:1521:orcl
jpa.username=syncope
jpa.password=syncope
jpa.dialect=org.apache.openjpa.jdbc.sql.OracleDictionary
jpa.pool.validationQuery=SELECT 1 FROM DUAL
#note: other connection pool settings can also be configured here, see persistenceContext.xml
quartz.jobstore=org.quartz.impl.jdbcjobstore.oracle.OracleDelegate
quartz.sql=tables_oracle.sql
logbackaudit.sql=audit_oracle.sql
database.schema=SYNCOPE

This assumes that you have an Oracle instance running on localhost, listening on its default port 1521 with a database

...

syncope

...

under tablespace

...

SYNCOPE

...

fully accessible by user

...

syncope

...

with password

...

syncope.

You will also need to

create directory
Code Block
core/src/main/resources/META-INF
download Oracle mapping file for the version you are building (1_2_X, 1.1.X, 1.0.X)
rename it to
Code Block
orm.xml
and copy it under the directory created above

Microsoft SQL Server

Code Block


jpa.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver
jpa.url=jdbc:sqlserver://localhost:1344;database=syncope;selectMethod=cursor;sendStringParametersAsUnicode=false
jpa.username=syncope
jpa.password=syncope
jpa.dialect=org.apache.openjpa.jdbc.sql.SQLServerDictionary
jpa.pool.validationQuery=SELECT 1
#note: other connection pool settings can also be configured here, see persistenceContext.xml
quartz.jobstore=org.quartz.impl.jdbcjobstore.MSSQLDelegate
quartz.sql=tables_sqlserversqlServer.sql
logbackaudit.sql=audit_sqlserver.sql
database.schema=

This assumes that you have an SQL Server instance running on localhost, listening on its default port 1344 with a database

...

syncope

...

fully accessible by user

...

syncope

...

with password

...

syncope.

You will also need to

create directory
Code Block
core/src/main/resources/META-INF
download MS SQL Server mapping file for the version you are building (1_2_X, 1.1.X, 1.0.X)
rename it to
Code Block
orm.xml
and copy it under the directory created above

JEE container

Apache Tomcat 7

This assumes that you have got Apache Tomcat 7 installed in directory $CATALINA_HOME.

Note

title	Debian / Ubuntu warning

If you have installed Apache Tomcat 7 via Debian / Ubuntu package, you will also need to

download the Tomcat JDBC Connection Pool JAR from Maven central repository, same version of the installed Tomcat 7
copy the downloaded JAR file under /usr/share/java

Set Environment

GNU / Linux - Mac OS X

...

Code Block
set JAVA_OPTS=-Djava.awt.headless=true -Dfile.encoding=UTF-8 -server -Xms1536m -Xmx1536m -XX:NewSize=256m -XX:MaxNewSize=256m -XX:PermSize=256m -XX:MaxPermSize=256m -XX:+DisableExplicitGC

...

Optionally, define a datasource for internal storage (following example is for MySQL): please check that the connection parameters are same as configured above.

Code Block

language	xml


<Resource name="jdbc/syncopeDataSource" auth="Container" type="javax.sql.DataSource"
          factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" testWhileIdle="true"
          testOnBorrow="true" testOnReturn="true" validationQuery="SELECT 1" validationInterval="30000"
          maxActive="100" minIdle="2" maxWait="10000" initialSize="2" removeAbandonedTimeout="2000020"
          removeAbandoned="true" logAbandoned="true" suspectTimeout="2000020"
          timeBetweenEvictionRunsMillis="5000" minEvictableIdleTimeMillis="5000"
          jdbcInterceptors="org.apache.tomcat.jdbc.pool.interceptor.ConnectionState;org.apache.tomcat.jdbc.pool.interceptor.StatementFinalizer"
          username="syncope" password="syncope" driverClassName="com.mysql.jdbc.Driver"
          url="jdbc:mysql://localhost:3306/syncope?characterEncoding=UTF-8"/>

Be sure to put the JDBC driver JAR file under $CATALINA_HOME/lib for the Datasource you have defined above.

Glassfish

...

4.1

Update core `glassfish-web.xml`

When using a datasource for internal storage, be sure to add

Code Block

language	xml


  <resource-ref>
    <res-ref-name>jdbc/syncopeDataSource</res-ref-name>
    <jndi-name>jdbc/syncopeDataSource</jndi-name>
  </resource-ref>

assuming that your Glassfish instance provides a datasource named jdbc/syncopeDataSource.

right after </context-root>>root> in core/src/main/webapp/WEB-INF/glassfish-web.xml.

JBoss AS 7.1

Use `JBossPersistenceMappingFactory`

Until issue OPENJPA-2229 gets fixed and reaches Apache OpenJPA mainstream, a temporary fix is needed.

Note

title	Version warning

Content of this paragraph applies to Apache Syncope < 1.2.0

Download Download this file, copy it under

...

under core/src/main/resources/

...

and replace

Code Block

...

languagexml
<entry key="openjpa.MetaDataFactory" value="org.apache.syncope.core.persistence.openjpa.JBossPersistenceMappingFactory(URLs=vfs:${project.build.directory}/cargo/configurations/jboss71x/deployments/${project.build.finalName}.war/WEB-INF/classes/, Resources=META-INF/orm.xml)"/>

...

with

Code Block

language

...

xml

<entry key="openjpa.MetaDataFactory" value="org.apache.syncope.core.persistence.openjpa.JBossPersistenceMappingFactory(URLs=vfs:/content/${project.build.finalName}.war/WEB-INF/classes/, Resources=META-INF/orm.xml)"/>

Fixing error messages at core startup

When core application starts up you will see many yet harmless error messages and stacktraces: this is due to an internal mechanism that looks for custom implementations of standard Apache Syncope interfaces.

If you want to remove such messages you can provide an override of the org.apache.syncope.core.init.ImplementationClassNamesLoader class: see an example here.

Wildfly 8.1

Note

title	Version warning

Content of this paragraph applies to Apache Syncope >= 1.2.X

Download this file, copy it under core/src/main/resources/ and replace

Code Block

language	xml

<entry key="openjpa.MetaDataFactory" value="jpa(URLs=vfs:${project.build.directory}/cargo/configurations/jboss71x/deployments/${project.build.finalName}.war/WEB-INF/classes/, Resources=META-INF/orm.xml)"/>

with

Code Block

language	xml

<entry key="openjpa.MetaDataFactory" value="jpa(URLs=vfs:/content/${project.build.finalName}.war/WEBINFWEB-INF/classes/, Resources=META-INF/orm.xml)"/>

Fixing error messages at core startup

When core application starts up you will see many yet harmless error messages and stacktraces: this is due to an internal mechanism that looks for custom implementations of standard Apache Syncope interfaces.

If you want to remove such messages you can provide an override of the org.apache.syncope.core.init.ImplementationClassNamesLoader class: see an example here.

Use DataSource

When using a DataSource, a few additional adjustments are needed.

core `web.xml`

Change

Code Block
<resource-ref> <res-ref-name>jdbc/syncopeDataSource</res-ref-name> <res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth> </resource-ref>

to

Code Block


  <resource-ref>
    <res-ref-name>jdbc/syncopeDataSource</res-ref-name>
    <res-type>javax.sql.DataSource</res-type>
    <res-auth>Container</res-auth>
    <lookup-name>java:/syncopeDataSource</lookup-name>
  </resource-ref>

...

When using a datasource for internal storage, be sure to add

Code Block
<resource-description> <jndi-name>syncopeDataSource</jndi-name> <res-ref-name>jdbc/syncopeDataSource</res-ref-name> </resource-description>

...

Modify console/src/main/resources/configurationconsole.properties so that provided properties reflects the scheme, hostname and port number where your JEE container is running and the URL context where Syncope core will be deployed.

For example, when running your JEE container on port 9080, you should have

Code Block
scheme=http host=localhost port=90808080 pathrootPath=/syncope/rest/

...

Once you are ready to deploy, you might would like to get rid of Wicket debug features provided by the console.

Just change development to deployment at the beginning of console/src/main/webapp/WEB-INF/web.xml.

Build and deploy

Assuming that you have created the two deployment directories defined above, just run

Syncope >= 1.2.0

Code Block
mvn clean package -Dconf.directory=/opt/syncope/conf -Dbundles.directory=/opt/syncope/bundles -Dlog.directory=/opt/syncope/log

At this point you can deploy core/target/syncope.war and console/target/syncope-console.war to your JEE container.

...

Point your favorite browser to administration console at http://localhost:90808080/syncope-console/^{Image Removed} (assuming that your JEE container is running on localhost, port 90808080)
Login as 'admin' / 'password'

Page tree

Versions Compared

Old Version 46

New Version Current

Key

Introduction

Deployment directory

Internal storage

PostgreSQL

MySQL

MariaDB

Oracle

Microsoft SQL Server

JEE container

Apache Tomcat 7

Set Environment

GNU / Linux - Mac OS X

Glassfish

4.1

Update core `glassfish-web.xml`

JBoss AS 7.1

Use `JBossPersistenceMappingFactory`

Fixing error messages at core startup

Wildfly 8.1

Fixing error messages at core startup

Use DataSource

core `web.xml`

Build and deploy

Syncope >= 1.2.0

Page tree

Page History

Versions Compared

Old Version 46

New Version Current

Key

Introduction

Deployment directory

Internal storage

PostgreSQL

MySQL

MariaDB

Oracle

Microsoft SQL Server

JEE container

Apache Tomcat 7

Set Environment

GNU / Linux - Mac OS X

Glassfish

4.1

Update core glassfish-web.xml

JBoss AS 7.1

Use JBossPersistenceMappingFactory

Fixing error messages at core startup

Wildfly 8.1

Fixing error messages at core startup

Use DataSource

core web.xml

Build and deploy

Syncope >= 1.2.0

Update core `glassfish-web.xml`

Use `JBossPersistenceMappingFactory`

core `web.xml`