WORK IN PROGRESS.....

The terms of use part of the consent module in version 3 of the IdP software is a simple way to comply with the AL1 & AL2 acceptable use policy criteria. This HowTo describes how to implement this module for SWAMID IdPs. It assumes that you already have a working IdP. We strongly recommend using the IdP installer.

The terms of use part of the consent module requires an additional database storage service in order to store terms of use records. This is in addition to the persistent id table created by the IdP installer. 

Configure a storage service

The full instructions are at https://wiki.shibboleth.net/confluence/display/IDP30/StorageConfiguration. We are going to create a JPAStorageService. 

1. Create an extra table using the MySQL (or other) code at https://wiki.shibboleth.net/confluence/display/IDP30/StorageConfiguration#StorageConfiguration-JPAStorageService
2. Download a driver for the JPAStorageService. In this example we will use the HikariCP JDBC connection pool, http://brettwooldridge.github.io/HikariCP/
3. Place the HikariCP jar file in the edit-webapp/WEB-INF/lib directory and run bin/build.sh to rebuild the war file.
4. Add the following to global.xml

<bean id="shibboleth.JPAStorageService.EntityManagerFactory"
 class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
 <property name="persistenceUnitName" value="storageservice" />
 <property name="packagesToScan" value="org.opensaml.storage.impl" />
 <property name="dataSource" ref="shibboleth.JPAStorageService.DataSource" />
 <property name="jpaVendorAdapter" ref="shibboleth.JPAStorageService.JPAVendorAdapter" />
 <property name="jpaDialect">
 <bean class="org.springframework.orm.jpa.vendor.HibernateJpaDialect" />
 </property>
 </bean>

<bean id="shibboleth.JPAStorageService.JPAVendorAdapter"
 class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
 <property name="database" value="MYSQL" />
 </bean>

<bean id="shibboleth.JPAStorageService.DataSource" 
 class="com.zaxxer.hikari.HikariDataSource" destroy-method="close" lazy-init="true"
 p:driverClassName="com.mysql.jdbc.Driver"
 p:jdbcUrl="jdbc:mysql://localhost:3306/storageservice"
 p:username="shibboleth"
 p:password="XXXX" />