Package com.veriplace.web

These classes simplify the process of using Veriplace user/location discovery within a servlet-based application.

See:
Description

Interface Summary

Redirector

Interface for an object that can redirect the end user to a different URL.

Class Summary

DefaultRedirector	Default implementation of Redirector.
Veriplace	Veriplace client for web applications.
VeriplaceState	Veriplace user, location, and permission information associated with the current HTTP request.

Exception Summary

RedirectedToVeriplaceException	Indicates that the application should stop handling the current HTTP request because Veriplace has redirected the end user, for user discovery or authorization.
RespondedException	Indicates that the application should stop handling the current HTTP request because Veriplace has already sent a response to the end user: either a redirect to another site (RedirectedToVeriplaceException), or a status page provided by a StatusViewRenderer (RespondedWithStatusViewException).
WaitingException	Indicates that Veriplace has started an asynchronous request which may take some time.

Package com.veriplace.web Description

These classes simplify the process of using Veriplace user/location discovery within a servlet-based application. The basic setup is that the application maintains an instance of Veriplace, and passes each servlet request to its Veriplace.open(HttpServletRequest, HttpServletResponse) method to obtain a VeriplaceState for that request. The application can then call Veriplace methods such as Veriplace.requireLocation(VeriplaceState) to obtain whatever information you need in the VeriplaceState. Redirects and callbacks are handled almost transparently: Veriplace throws an exception to indicate that the request flow needs to be interrupted, and constructs a callback URL to preserve all properties of the current state.

There are several levels of simplification you can use for this process, depending on the structure of your application:

• If you derive your servlet class from AbstractVeriplaceServlet, you can specify the information your servlet needs from Veriplace with the UsesVeriplace annotation. Any necessary redirects and callbacks will be done before your servlet code executes.
• If you use the Spring Web MVC framework, you can set up your Veriplace objects using the standard bean configuration system, and apply interceptors (see VeriplaceInterceptor) which will perform the necessary Veriplace requests before your controller executes.
• Within an ordinary JSP, you can use the Veriplace custom tag library to access user and location data.

The web classes do not provide wrappers for every Veriplace API, just the ones that have multiple steps or require keeping track of more state information. You can still use the full set of Veriplace APIs through the Client class, which can be accessed through the Veriplace.getClient() method of the Veriplace object.