org.pac4j.vertx

Class Pac4jHelper

java.lang.Object

org.pac4j.vertx.Pac4jHelper

public class Pac4jHelper
extends Object

This helper class is usefull for sending messages on the event bus to the pac4j manager module.
The three basic messages are:

• redirect
• redirectUrls
• authenticate

Since:

1.0.0

Author:

Michael Remond

Constructor Summary

Constructors

Constructor and Description
Pac4jHelper(org.vertx.java.core.Vertx vertx)
Pac4jHelper(org.vertx.java.core.Vertx vertx, String address, EventBusObjectConverter ebConverter)

Method Summary

Modifier and Type	Method and Description
void	authenticate(org.vertx.java.core.http.HttpServerRequest req, org.vertx.java.core.json.JsonObject sessionAttributes, String clientName, org.vertx.java.core.Handler<org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject>> handler) Send an authenticate message to the pac4j manager.
org.vertx.java.core.json.JsonObject	buildUserProfileResponse(Object profile, org.vertx.java.core.json.JsonObject sessionAttributes)
org.pac4j.core.profile.UserProfile	decodeUserProfile(Object profile)
String	getFullRequestURL(org.vertx.java.core.http.HttpServerRequest request) Get the full url from the given request.
void	getRedirectUrls(org.vertx.java.core.http.HttpServerRequest req, org.vertx.java.core.json.JsonObject sessionAttributes, org.vertx.java.core.Handler<org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject>> handler, String... clients) Get the redirection urls for the given client names.
org.vertx.java.core.json.JsonObject	getSessionAttributes(org.vertx.java.core.json.JsonObject response)
Object	getUserProfileFromResponse(org.vertx.java.core.json.JsonObject response)
org.pac4j.core.profile.UserProfile	getUserProfileFromSession(org.vertx.java.core.json.JsonObject session)
boolean	isErrorMessage(org.vertx.java.core.json.JsonObject response)
boolean	isRequiresHttpAction(org.vertx.java.core.json.JsonObject response)
void	redirect(org.vertx.java.core.http.HttpServerRequest req, org.vertx.java.core.json.JsonObject sessionAttributes, String clientName, boolean protectedResource, boolean isAjax, org.vertx.java.core.Handler<org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject>> handler) Send a redirect message to the pac4j manager.
void	saveUserProfileInSession(Object profile, org.vertx.java.core.json.JsonObject session)
void	sendErrorResponse(org.vertx.java.core.http.HttpServerResponse serverResponse, org.vertx.java.core.json.JsonObject response) Generate an error response.
void	sendResponse(org.vertx.java.core.http.HttpServerResponse response, org.vertx.java.core.json.JsonObject event) Generate the Vertx response based on the pac4j manager response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pac4jHelper

public Pac4jHelper(org.vertx.java.core.Vertx vertx)

Pac4jHelper

public Pac4jHelper(org.vertx.java.core.Vertx vertx,
                   String address,
                   EventBusObjectConverter ebConverter)

Method Detail

redirect

public void redirect(org.vertx.java.core.http.HttpServerRequest req,
                     org.vertx.java.core.json.JsonObject sessionAttributes,
                     String clientName,
                     boolean protectedResource,
                     boolean isAjax,
                     org.vertx.java.core.Handler<org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject>> handler)

Send a redirect message to the pac4j manager. The response will contain the http information to send back to the user.

Parameters:

req - the HTTP request

sessionAttributes - the session attributes

clientName - the client name

protectedResource - whether it is a protected resource

isAjax - whether it is an AJAX call

handler - the handler

getRedirectUrls

public void getRedirectUrls(org.vertx.java.core.http.HttpServerRequest req,
                            org.vertx.java.core.json.JsonObject sessionAttributes,
                            org.vertx.java.core.Handler<org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject>> handler,
                            String... clients)

Get the redirection urls for the given client names.

Parameters:

req - the HTTP request

sessionAttributes - the session attributes

handler - the handler

clients - the pac4j clients

authenticate

public void authenticate(org.vertx.java.core.http.HttpServerRequest req,
                         org.vertx.java.core.json.JsonObject sessionAttributes,
                         String clientName,
                         org.vertx.java.core.Handler<org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject>> handler)

Send an authenticate message to the pac4j manager. The response will contain the user profile if the authentication succeeds or the http information to send back to the user otherwise.

Parameters:

req - the HTTP request

sessionAttributes - the session attributes

handler - the handler

clientName - the client name

sendResponse

public void sendResponse(org.vertx.java.core.http.HttpServerResponse response,
                         org.vertx.java.core.json.JsonObject event)

Generate the Vertx response based on the pac4j manager response.

Parameters:

response - the HTTP response

event - the event

sendErrorResponse

public void sendErrorResponse(org.vertx.java.core.http.HttpServerResponse serverResponse,
                              org.vertx.java.core.json.JsonObject response)

Generate an error response.

Parameters:

serverResponse - the HTTP response

response - the message response

getFullRequestURL

public String getFullRequestURL(org.vertx.java.core.http.HttpServerRequest request)

Get the full url from the given request.

Parameters:

request - the HTTP request

Returns:

the current full url

getUserProfileFromResponse

public Object getUserProfileFromResponse(org.vertx.java.core.json.JsonObject response)

getUserProfileFromSession

public org.pac4j.core.profile.UserProfile getUserProfileFromSession(org.vertx.java.core.json.JsonObject session)

saveUserProfileInSession

public void saveUserProfileInSession(Object profile,
                                     org.vertx.java.core.json.JsonObject session)

decodeUserProfile

public org.pac4j.core.profile.UserProfile decodeUserProfile(Object profile)

buildUserProfileResponse

public org.vertx.java.core.json.JsonObject buildUserProfileResponse(Object profile,
                                                                    org.vertx.java.core.json.JsonObject sessionAttributes)

getSessionAttributes

public org.vertx.java.core.json.JsonObject getSessionAttributes(org.vertx.java.core.json.JsonObject response)

isRequiresHttpAction

public boolean isRequiresHttpAction(org.vertx.java.core.json.JsonObject response)

isErrorMessage

public boolean isErrorMessage(org.vertx.java.core.json.JsonObject response)