Skip to content

Latest commit

 

History

History
91 lines (51 loc) · 3.98 KB

README.md

File metadata and controls

91 lines (51 loc) · 3.98 KB

PicketLink 2.5 Extension for JBoss Enterprise Application Platform

This project is an extension for JBoss Enterprise Application Server that enables PicketLink for deployments.

The extension provides a set of services and deployment behaviours for most of the PicketLink projects, such as:

System Requirements

The extension is currently designed and implemented considering the following requirements:

  • Java 1.6

  • JBoss EAP 6.1 (AS 7.2.0.Final-SNAPSHOT)

  • Maven 3.0.3 or newer, to build and install the extension

    Important note The extension requires a specific organization for the PicketLink libraries inside the JBoss EAP modules directory. While the application server is not update, you must configure your installation in order to use the extension. See the JBoss Application Server Configuration section for more details.

How to build

You can build this project in several ways, depending of your objectives.

The simplest way to build this project and to generate the artifacts is executing the following command:

mvn clean install

In this case, only the unit tests will be executed.

If you want to perform a full build, running also the integration tests you need to execute the following command:

mvn -Pintegration-tests clean install

JBoss Application Server Configuration

Using a Pre-configured JBoss AS Installation

The most simple and fast way to get the subsystem up and running is using the JBoss Application Server installation used during the integration tests. After executing the following command:

mvn -Pintegration-tests clean install

Navigate to the target/integration-tests/containers/jboss-eap-6.1/ directory and use this installation to deploy your applications.

Manual Installation

You can use the PicketLink Installer. Follow the instructions there.

Important Note: Only versions 2.5.2.Final and later support the subsystem installation on EAP.

Configuring your JBoss AS installation with the PicketLink Extension and Subsystem

Change your standalone.xml to add an extension for the PicketLink module:

      <extensions>
                ...
              <extension module="org.picketlink.as.extension"/>
      </extensions>

Now, you can configure the PicketLink Subsystem using the subsystem's domain model:

<profile>
    <subsystem xmlns="urn:jboss:picketlink:1.0">
    	
    	<!-- Use the domain model schema to configure the subsystem -->
    	
    </subsystem>

You can get some examples about how to configure the PicketLink Subsystem from the following file:

https://github.com/picketlink/picketlink-as-subsystem/blob/master/src/test/resources/picketlink-subsystem.xml

How to use

Please, follow the documentation at http://docs.jboss.org/picketlink/2/latest/reference/html/ch10.html.

Federation Services

Please, follow the documentation at https://docs.jboss.org/author/display/PLINK/PicketLink+AS7+Subsystem.

Running and Debugging the Integration Tests in Eclipse

First, import the project into your IDE.

Follow the instructions at [Using a Pre-configured JBoss AS Installation] (#) to get a pre-configured JBoss AS installation with all configuration required to run the integration tests.

Go to the Maven configurations for your Eclipse project and activate the following profile:

arquillian-remote

Now, start your server and run one of the integration tests.