PicketLink

Get Ready and Fast !

This guide will walk you through downloading, installing and running PicketLink for the first time. It will then introduce to some of the key features of PicketLink.

Obtaining PicketLink

PicketLink can be obtained in different ways, depending on your needs.

If you're looking for Java JEE Application Security, what means you want to use PicketLink Authentication and Authorization API, you should prefer configuring PicketLink as a dependency in your Apache Maven project. The recommendation is the same if you're looking the Identity Management API.

But if you're looking for the PicketLink Federation features, you should prefer the PicketLink Installer approach, as described in the next sections. It is easier and fully compatible with the old v2.1 versions.

As a Maven Dependency

PicketLink libraries are available on JBoss Release Repository and Maven Central.

If your project is using Apache Maven, you only need the following dependency in your POM:

<properties>
	<picketlink.version>2.6.0.Beta3</picketlink.version>
</properties>

<dependencies>
	<dependency>
		<groupId>org.picketlink</groupId>
		<artifactId>picketlink-api</artifactId>
		<scope>compile</scope>
		<version>${picketlink.version}</version>
	</dependency>
	
	<dependency>
		<groupId>org.picketlink</groupId>
		<artifactId>picketlink-impl</artifactId>
		<scope>runtime</scope>
		<version>${picketlink.version}</version>
	</dependency>
</dependencies>	

You can use a Bill of Materials (BOM) to configure PicketLink in your project.

<properties>
	<version.picketlink.javaee.bom>2.6.0.Beta3</version.picketlink.javaee.bom>
</properties>

</dependencyManagement>
	<dependency>
		<groupId>org.picketlink</groupId>
		<artifactId>picketlink-javaee-6.0</artifactId>
		<type>pom</type>
		<scope>import</scope>
		<version>${version.picketlink.javaee.bom}</version>
	</dependency>
</dependencyManagement>

<dependencies>
	<dependency>
		<groupId>org.picketlink</groupId>
		<artifactId>picketlink-api</artifactId>
		<scope>compile</scope>
	</dependency>
	
	<dependency>
		<groupId>org.picketlink</groupId>
		<artifactId>picketlink-impl</artifactId>
		<scope>runtime</scope>
	</dependency>
</dependencies>	

Please note that when using JBoss BOMs you're tied to a specific version of PicketLink. So always make sure you're using the BOM version with the latest PicketLink version. Check our documentation for more details.


Quickstarts

PicketLink provides a plenty of quickstarts to let you drive quickly with some of the most important features.

The quickstarts are available on the PicketLink Quickstarts repository.

Follow the instructions there to get them and deploy in a JBoss Enterprise Application Platform 6 server.

Documentation

The PicketLink documentation is the best source of information about all the PicketLink features and usage.

The documentation is available here