Documentation

About setup

Your setup will depend on whether or not you use maven. Also, if you're going to use the xml configuration, there's a bit of xml namespace setup to do.

With maven

Add the following dependency block to your pom:

<dependency>
    <groupId>com.google.code.spring-crypto-utils</groupId>
    <artifactId>spring-crypto-utils</artifactId>
    <version>1.4.0</version>
</dependency>

Maven Central Ready

Spring Crypto Utils is in maven central, so there's no extra repository to setup in the pom. If you had previously setup our custom repository, you can safely remove it from your poms now as all publicily released versions have been (and will be) uploaded to central.

Without maven

Download the latest jar and put the file in the classpath of your application.

The following jars are also needed:

  • Apache Commons
    • commons-logging:commons-logging:jar:1.2 download
    • commons-codec:commons-codec:jar:1.10 download
  • Spring Framework
    • aopalliance:aopalliance:jar:1.0 download
    • org.springframework:spring-aop:jar:4.1.4.RELEASE download
    • org.springframework:spring-beans:jar:4.1.4.RELEASE download
    • org.springframework:spring-context:jar:4.1.4.RELEASE download
    • org.springframework:spring-core:jar:4.1.4.RELEASE download
    • org.springframework:spring-expression:jar:4.1.4.RELEASE download

Xml Namespace

To use the xml configuration, you will need to declare the crypt namespace in your spring context xml configuration files, like this:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:crypt="http://springcryptoutils.com/schema/crypt"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://springcryptoutils.com/schema/crypt
        http://springcryptoutils.com/schema/crypt.xsd">

</beans>

This gets you full autocompletion support in an xsd aware editor such as Intellij Idea.


What now?

With the setup out of our way, here's what to do next.

What to do next depends on your specific needs. Please go to the documentation link above in the navigation bar and choose a topic of your interest.