Return-Path: X-Original-To: apmail-deltaspike-commits-archive@www.apache.org Delivered-To: apmail-deltaspike-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id EF0AD17DE9 for ; Thu, 23 Oct 2014 13:00:59 +0000 (UTC) Received: (qmail 78917 invoked by uid 500); 23 Oct 2014 13:00:59 -0000 Delivered-To: apmail-deltaspike-commits-archive@deltaspike.apache.org Received: (qmail 78884 invoked by uid 500); 23 Oct 2014 13:00:59 -0000 Mailing-List: contact commits-help@deltaspike.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@deltaspike.apache.org Delivered-To: mailing list commits@deltaspike.apache.org Received: (qmail 78875 invoked by uid 99); 23 Oct 2014 13:00:59 -0000 Received: from ec2-54-191-145-13.us-west-2.compute.amazonaws.com (HELO mx1-us-west.apache.org) (54.191.145.13) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 23 Oct 2014 13:00:59 +0000 Received: from mx1-us-west.apache.org (localhost [127.0.0.1]) by mx1-us-west.apache.org (ASF Mail Server at mx1-us-west.apache.org) with ESMTP id 43E6426EEC for ; Thu, 23 Oct 2014 13:00:59 +0000 (UTC) Received: by mx1-us-west.apache.org (ASF Mail Server at mx1-us-west.apache.org, from userid 114) id 3891726EEA; Thu, 23 Oct 2014 13:00:59 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on mx1-us-west.apache.org X-Spam-Level: X-Spam-Status: No, score=-1.4 required=10.0 tests=RP_MATCHES_RCVD, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from eris.apache.org (eris.apache.org [140.211.11.4]) by mx1-us-west.apache.org (ASF Mail Server at mx1-us-west.apache.org) with ESMTP id 08F7026F02 for ; Thu, 23 Oct 2014 13:00:44 +0000 (UTC) Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id DEDBC2388C35 for ; Thu, 23 Oct 2014 13:00:43 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r926547 [7/10] - in /websites/staging/deltaspike/trunk/content: ./ documentation/staging/ Date: Thu, 23 Oct 2014 13:00:41 -0000 To: commits@deltaspike.apache.org From: buildbot@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20141023130043.DEDBC2388C35@eris.apache.org> X-Virus-Scanned: ClamAV using ClamSMTP Added: websites/staging/deltaspike/trunk/content/documentation/staging/jsf.html ============================================================================== --- websites/staging/deltaspike/trunk/content/documentation/staging/jsf.html (added) +++ websites/staging/deltaspike/trunk/content/documentation/staging/jsf.html Thu Oct 23 13:00:41 2014 @@ -0,0 +1,2603 @@ + + + + + + + + + +JSF + + + + + + + + + + + + + + +
+
+
+ + Apache + DeltaSpike +
+ +
+ + +
+
+
+ +
+
+
+
+

JSF

+
+ +
+ +
+ +
+

Multi-Window Handling

+
+
+

Intro

+
+

Historic Considerations

+
+

Until the end of the 1990s web browsers are usually single threaded and +only had one window. But in the last years browsers supporting multiple +windows or even tab became the standard. Since those days lots of +efforts went into uniquely identifying a single browser window on the +server side. Sadly browser windows still lack of a native windowId, thus +maintaining web application data in @SessionScoped backing beans is +still used in most of the cases.

+
+
+
+

How JSF-2 changed the world

+
+

The MyFaces Orchestra community did a good summary about the various +ways to handle multiple window support in JSF Applications. Those +findings are still valid and up to date, but the environmental +conditions have changed slightly since then. It is easy to pass a +windowId around with a POST request, but it gets tricky with GET +requests. Due to the new JSF-2 ability to use bookmarkable URLs and deep +links, a typical JSF-2 application contains much more GET links than we +used to see in JSF-1, thus we have far more href links to cope with.

+
+
+
+

Standard windowId Handling

+
+

With a classical approach we would not be able to simply add a windowId +parameter to such links because if the user would open the link in a new +browser window or tab, we would carry the windowId - and thus the window +scope - over to the new browser tab/window. The classic solution was to +omit the windowId for all GET links, but by doing this we would now +loose the window scope far too often with JSF-2! Marios summary also +contains a method to prevent this problem by storing a value directly in +the browser window via JavaScript. Usually this is rendered and executed +in the same page as the user form. See the "Post-render window +detection" paragraph for a more detailed description. The major downside +of this solution is that we might already pollute 'foreign' beans (and +destroy their information) while rendering the page, which means this is +not feasible as general solution.

+
+
+
+
+

Available modes

+
+

CLIENTWINDOW

+
+

Each GET request results in an intermediate small html page which checks +if the browser tab fits the requested windowId. When the windowId is +valid, a unique token (called dsRid) will be generated for the current +request and added to the URL. In addition a cookie with with the +dsRid/windowId will be added. On the server side, the verified windowId +will be extracted from the cookie. For POST request detection, the +windowId will be added as hidden input to all forms.

+
+
+
Advantage
+
+
    +
  • +

    Covers all edge cases

    +
    • +
+
+
+
+
Disadvantage
+
+
    +
  • +

    Having the windowhandler.html site rendered between requests sometimes +leads to some 'flickering' if the destination page takes some time to +load. The browser first renders our windowhandler and only after that +the original page will get loaded. This effect may be minimized by +branding the windowhandler.html page and providing an own one with a +bgcolor which matches your application. For html-5 aware browsers we +also got rid of this flickering by storing away a 'screenshot' of the +first page in onclick() and immediately restore this 'screenshot' on the +intermediate windowhandler.html page. Technically we do this by storing +away the and css information into the html5 localStorage and restore them on the +intermediate page. We also introduced a WindowConfig which is able to +parse a request and decide upon the UserAgent or any other information +if a client will get an intermediate page or if he gets the result page +directly.

    +
    • +
+
+
+
+
Change windowhandler.html
+
+

To customize the look & feel of the windowhandler.html, you can simply +provide a own via:

+
+
+
+
@Specializes
+public class MyClientWindowConfig extends DefaultClientWindowConfig
+{
+    @Override
+    public String getClientWindowHtml()
+    {
+        return "<html><body>Loading...</body></html>";
+    }
+}
+
+
+
+
+
+

LAZY

+
+

Always appends the windowId to all, from JSF generated, URLs. On the +first GET request without a windowId, it will generate a new windowId +and redirect, with the windowId in the URL, to the same view again. The +current windowId will be stored in the window.name variable on the +client side. For all further requests, a lazy check will be performed to +check if the windowId in the URL is matching with the window.name. If +it’s not matching, the view will be refreshed with the right windowId in +the URL.

+
+
+
Advantage
+
+
    +
  • +

    No windowhandler.html / loading screen required

    +
    • +
+
+
+
+
Disadvantage
+
+
    +
  • +

    It could happen that 2 tabs will share the same windowId for 1 request +because the LAZY mode will check lazily, after rendering the view, if +the windowId matches the window.name. Therefore it could happen that +@ViewAccessScoped or other scopes will unintentionally be destroyed.

    +
    • +
+
+
+
+
Workflow example
+
+

First GET request with windowId

+
+
+
    +
  • +

    Renders the view

    +
    • +
  • +

    Stores the windowId as window.name on the client side

    +
    • +
+
+
+

First GET request without windowId

+
+
+
    +
  • +

    Redirect to the same view with a new windowId in the URL

    +
    • +
  • +

    Renders the view

    +
    • +
  • +

    Stores the windowId as window.name on the client side

    +
    • +
+
+
+

Further GET request with windowId

+
+
+
    +
  • +

    Renders the view

    +
    • +
  • +

    Checks if the requested windowId matches the window.name

    +
    • +
  • +

    If it does not match, reload the URL with the right windowId taken +from window.name

    +
    • +
+
+
+

Further GET request without windowId

+
+
+
    +
  • +

    Redirect to the same view with a new windowId in the URL

    +
    • +
  • +

    Renders the view

    +
    • +
  • +

    If it does not match, reload the URL with the right windowId taken +from window.name

    +
    • +
+
+
+
+
+

NONE

+
+

Any window or browser tab detection will be disabled for the current +request. Scopes like @WindowScoped, @GroupedConversationScoped or +@ViewAccessScoped will not work. This is also the default mode if the +current request doesn’t support Javascript or if the user agent is a +bot/crawler.

+
+
+
+

DELEGATED

+
+

Delegates the complete window handling to the new JSF 2.2 ClientWindow +(if not disabled).

+
+
+
+

CUSTOM

+
+

Enables to use an complete own +org.apache.deltaspike.jsf.spi.scope.window.ClientWindow +implementation.

+
+
+
+
+

Configuration

+
+

ds:windowId

+
+

The component ds:windowId +(xmlns:ds="http://deltaspike.apache.org/jsf") is required to enable +the full control of the DeltaSpike window handling. It will import and +render the required script parts for both LAZY and CLIENTWINDOW +mode. The best way, to apply it for all views, is to add this component +to all of your templates.

+
+
+
+

ds:disableClientWindow

+
+

Similiar to JSF 2.2' disableClientWindow attribute, +ds:disableClientWindow provides the ability to disable the rendering +of the windowId to all links of all child components:

+
+
+
+
<ds:disableClientWindow>
+    <h:link value="Link without windowId" outcome="target.xhtml" />
+</ds:disableClientWindow>
+<h:link value="Link with windowId" outcome="target.xhtml"/>
+
+
+
+
+

Switch Mode

+
+

To switch the mode, just provide a +org.apache.deltaspike.jsf.api.config.JsfModuleConfig and overwrite +#getDefaultWindowMode:

+
+
+
+
@Specializes
+public class MyJsfModuleConfig extends JsfModuleConfig
+{
+    @Override
+    public ClientWindowConfig.ClientWindowRenderMode getDefaultWindowMode()
+    {
+        //...
+    }
+}
+
+
+
+
+

Provide a custom ClientWindow

+
+

If you would like to provide an custom +org.apache.deltaspike.jsf.spi.scope.window.ClientWindow +implementation, you can just do it e.g. via CDI alternatives:

+
+
+
+
@ApplicationScoped
+public class MyClientWindow implements ClientWindow
+{
+    //...
+}
+
+
+
+

Don’t forget to set the ClientWindowRenderMode to 'CUSTOM' via the +JsfModuleConfig:

+
+
+
+
@Specializes
+public class MyJsfModuleConfig extends JsfModuleConfig
+{
+    @Override
+    public ClientWindowConfig.ClientWindowRenderMode getDefaultWindowMode()
+    {
+        return ClientWindowConfig.ClientWindowRenderMode.CUSTOM;
+    }
+}
+
+
+
+
+
+

Based Scopes

+
+
    +
  • +

    @WindowScoped

    +
    • +
  • +

    @ViewAccessScoped

    +
    • +
  • +

    @GroupedConversationScoped

    +
    • +
+
+
+
+
+
+

Scopes

+
+
+

@WindowScoped

+
+

The window-scope is like a session per window. That means that the data +is bound to a window/tab and it not shared between windows (like the +session scope does). Usually you need the window-scope instead of the +session-scope. There aren’t a lot of use-cases which need shared data +between windows.

+
+
+
+
@WindowScoped
+public class PreferencesBean implements Serializable
+{
+    //...
+}
+
+
+
+
+

@ViewAccessScoped (since 0.6)

+
+

In case of conversations you have to un-scope beans manually (or they +will be terminated automatically after a timeout). However, sometimes +you need beans with a lifetime which is as long as needed and as short +as possible - which are terminated automatically (as soon as possible). +In such an use-case you can use this scope. The simple rule is, as long +as the bean is referenced by a page - the bean will be available for the +next page (if it’s used again the bean will be forwarded again). It is +important that it’s based on the view-id of a page (it isn’t based on +the request) so e.g. Ajax requests don’t trigger a cleanup if the +request doesn’t access all view-access scoped beans of the page. That’s +also the reason for the name @ViewAccessScoped.

+
+
+
+
@ViewAccessScoped
+public class WizardBean implements Serializable
+{
+    //...
+}
+
+
+
+

Hint: @ViewAccessScoped beans are best used in conjunction with the +CLIENTWINDOW window handling, which ensures a clean browser-tab +separation without touching the old windowId. Otherwise a 'open in new +tab' on a page with a @ViewAccessScoped bean might cause the termination +(and re-initialization) of that bean.

+
+
+
+

@GroupedConversationScoped (since 0.6)

+
+

See (Grouped-)Conversations

+
+
+
+

@ViewScoped

+
+

DeltaSpike provides an CDI context for the JSF 2.0/2.1 +@javax.faces.bean.ViewScoped. You can simply annotate your bean with +@javax.faces.bean.ViewScoped and @Named.

+
+
+
+

JSF 2.0 Scopes

+
+

JSF 2.0 introduced new annotations as well as a new scope - the View +Scope. CODI allows to use all the CDI mechanisms in beans annotated +with:

+
+
+
    +
  • +

    javax.faces.bean.ApplicationScoped

    +
    • +
  • +

    javax.faces.bean.SessionScoped

    +
    • +
  • +

    javax.faces.bean.RequestScoped

    +
    • +
  • +

    javax.faces.bean.ViewScoped

    +
    • +
+
+
+

Furthermore, the managed-bean annotation (javax.faces.bean.ManagedBean) +is mapped to @Named from CDI.

+
+
+

All these annotations are mapped automatically. So you won’t face +issues, if you import a JSF 2 annotation instead of the corresponding +CDI annotation.

+
+
+
+
+
+

Integration with DeltaSpike type-safe messages

+
+
+

You can use DeltaSpike type-safe messages +with JSF to provide i18n messages and test to an JSF appplicaton.

+
+
+

JSF module is also capable to use messages provided through in +faces-config.xml file. The element allows you to override JSF default +messages (Section 2.5.2.4 of the JSF specification contains the list of +all JSF default messages that could be override.).

+
+
+

DeltaSpike can also reuse the same file to provide type-safe messages so +you don’t have to use the naming convention nor @MessageContextConfig. +If there is a config for supported locales it will be checked as well +and fallback to the configured default locale.

+
+
+

Example:

+
+
+
+
@MessageBundle
+public interface SimpleMessage
+{
+    @MessageTemplate("{welcome_to_deltaspike}")
+    String welcomeToDeltaSpike();
+}
+
+@Model
+public class PageBean
+{
+
+    @Inject
+    private SimpleMessage messages;
+
+    public void actionMethod(){
+        FacesContext.getCurrentInstance().addMessage(null,new FacesMessage(messages.welcomeToDeltaSpike()));
+    }
+
+}
+
+
+org.apache.deltaspike.example.message.SimpleMessage
+
+->
+
+org/apache/deltaspike/example/message/SimpleMessage.properties
+org/apache/deltaspike/example/message/SimpleMessage.properties
+org/apache/deltaspike/example/message/SimpleMessage_en.properties
+org/apache/deltaspike/example/message/SimpleMessage_de.properties
+
+...
+
+//content (as usual in message bundle files):
+welcome_to_deltaspike=Welcome to DeltaSpike
+//Overrided JSF messages
+javax.faces.component.UIInput.REQUIRED = {0}: Please enter a value
+
+
+
+

On faces-config.xml file:

+
+
+
+
<faces-config>
+    <application>
+        <message-bundle>org.apache.deltaspike.example.message.SimpleMessage</message-bundle>
+    </application>
+</faces-config>
+
+
+
+
+
+

Type-safe View-Configs

+
+
+

Intro

+
+

Type-safe view-configs are static configs which can be used in +combination with every view-technology which is based on Java. Currently +DeltaSpike itself provides an integration for JSF, however, the basic +concepts are independent of it. (Since DeltaSpike provides the default +integration only for JSF, the whole documentation for view-configs is +located here.)

+
+
+

Thanks to features like multiple (meta-data-)inheritance via interfaces, +it provides a powerful approach to bind meta-data to one or multiple +views. In case of the JSF integration it’s possible to provide e.g. +type-safe meta-data for security, navigation, callbacks for +view-controllers. Beyond configuring view (/pages) via this concept, +it’s also possible to use the (view-)config classes for type-safe +navigation. Since it’s std. Java, you can benefit from any Java-IDE and +you don’t need special IDE-Addons to use it efficiently.

+
+
+

Even the concepts provided by modules (of DeltaSpike itself) are based +on the basic API provided by the Core. So it’s possible to introduce +custom concepts the same way DeltaSpike itself does.

+
+
+
+

Motivation

+
+

Instead of learning the concepts and rules of view-configs provided by +DeltaSpike, it might be easier for simple demos to just type some +simple(r) strings. So why should you use something which is slightly +more work initially?

+
+
+

The short answer is:

+
+
+

It gives a good return in case of real applications (esp. beyond simple demos).

+
+
+

The long answer is:

+
+
+

You can benefit from it from the first second:

+
+
+
    +
  • +

    It’s type-safe →

    +
    +
      +
    • +

      the Java compiler ensures that you don’t have typos at the final usages (and the rest can be checked during bootstrapping of the application)

      +
      • +
    • +

      you can benefit from the auto.complete features of any modern Java IDE.

      +
      • +
    +
    +
    • +
  • +

    If you change the name of a file/folder, you need only one (easy) code-change in a single place and your (std. Java-) IDE will do the rest for you (= update all usages) without a special plug-in

    +
    • +
  • +

    It’s possible to restrict the navigation target → you can ensure that the navigation target is still the intended one (e.g. after a refactoring)

    +
    • +
  • +

    You can configure meta-data in a central place (which can get inherited via multiple inheritance based on Java interfaces)

    +
    • +
  • +

    Easier for developers to find usages

    +
    • +
  • +

    Allows easy(er) refactorings and maintenance

    +
    • +
  • +

    You can use your IDE more efficiently esp. in large projects (there are some users who initially switched to it, because their tools for displaying the config they had before open large config files very slowly…​)

    +
    • +
  • +

    Modern Java IDEs show inheritance of interfaces and classes in a nice way. Since the view-config is based on std. classes and interfaces, you can benefit from it easily.

    +
    • +
+
+
+

Advantages which are planned for later (= currently not supported):

+
+
+
    +
  • +

    It’s possible to check if the configured folders and files really exist during/after the bootstrapping phase of the application (currently it isn’t implemented, but it’s possible to do it).

    +
    • +
  • +

    It’s also easy(er) for tools (IDE plugins,…​) to validate it

    +
    • +
  • +

    It’s possible to validate the config (if the corresponding path (view or folder) really exists (after v0.5 it’s done out-of-the-box)

    +
    • +
+
+
+

If you are still not convinced, you just have to try it. You will see how your daily workflow benefits from it pretty soon.

+
+
+
+

Bean-discovery-mode annotated

+
+

CDI 1.1 introduced a concept called bean-discovery-mode. If you would +like to use the mode annotated, please have a look at the hint at +@ViewConfigRoot

+
+
+
+

Basic API usages

+
+

While reading this section keep the following simple rules in mind: +Meta-data gets inherited along the path of Java inheritance +File-/Folder- paths are build based on nesting classes and interfaces +Usually users don’t need to be aware of all descriptors, SPIs,…​ which +are described by this documentation.

+
+
+

There are a lot of possibilities to configure views and some of them are +optional. The following examples show some of them in combination with +features provided by the JSF- and Security-Module of DeltaSpike.

+
+
+

The following example shows the minimal syntax for providing a config +for a view (/page).

+
+
+
+
public class MyPage implements ViewConfig
+{
+}
+
+
+
+

Since it’s a class (and not an interface) it’s autom. recognized as +config for a page (and not a folder) and the default settings get +applied during bootstrapping. In case of JSF you can use it for +navigation e.g. via action-methods.

+
+
+
+
public Class<? extends ViewConfig> toNextPage()
+{
+    return MyPage.class;
+}
+
+
+
+

This leads to a forward to /myPage.xhtml. Information like base-path, +file- (and folder-)name/s, file-extension, navigation mode, +view-params,…​ can be customized with the corresponding +(meta-data-)annotations. One of those annotations provided by the JSF +module (which is optional) is @View. That means the following example +leads to the same as the first one.

+
+
+
+
@View //optional
+public class MyPage implements ViewConfig
+{
+}
+
+
+
+

But it’s also possible to reflect the folder structure via nesting of +interfaces and classes. An example for it is:

+
+
+
+
public interface Pages
+{
+    class Index implements ViewConfig { }
+
+    interface AdminArea extends ViewConfig
+    {
+        class Index implements Admin { }
+    }
+}
+
+
+
+

In case of the JSF integration it leads to the following view-ids: +/pages/index.xhtml /pages/adminArea/index.xhtml

+
+
+

Like the optional @View for pages represented by the classes, it’s +possible to use the optional @Folder annotation for directories +represented by the (nested) interfaces.

+
+
+

Furthermore, it’s possible to inherit meta-data along with the normal +inheritance.

+
+
+

In the following example Pages.Admin.Index, Pages.Admin.Home and +Pages.Admin.Statistics.Home inherit the meta-data from Pages.Admin +because they implement the interface whereas +Pages.Admin.Statistics.Index doesn’t. However, Pages.Admin.Home +overrides View#navigation. During the bootstrapping process the +meta-data gets merged and at runtime you only see the final result +(which is cached).

+
+
+
+
public interface Pages
+{
+    @View(name = "home", extension = JSP)
+    class Index implements ViewConfig { }
+
+    @View(navigation = REDIRECT, viewParams = INCLUDE)
+    interface Admin extends ViewConfig
+    {
+        interface Statistics
+        {
+            @View //optional
+            class Index implements ViewConfig { }
+
+            class Home implements Admin { }
+        }
+
+        class Index implements Admin { }
+
+        @View(navigation = FORWARD)
+        class Home implements Admin { }
+    }
+}
+
+
+
+

In this case Pages.Admin.Statistics is just an interface to reflect +the folder structure. For sure it’s also possible that it extends an +existing view-config interface and other folders and/or pages inherit +its meta-data (like Pages.Admin).

+
+
+

Furthermore, inheritance can be used to ensure navigation to the correct +area in the application. In the following example the return type of the +action-method (and therefore the compiler of Java) ensures that the +navigation target of this method is within the admin-area.

+
+
+
+
public Class<? extends Pages.Admin> toNextPage()
+{
+    return Pages.Admin.Index.class;
+}
+
+
+
+

File (@View) and Folder (@Folder) paths

+
+

@View as well as @Folder are optional annotations. @Folder is only +needed for using a different folder-name or for marking folder configs +if they don’t inherit from +org.apache.deltaspike.core.api.config.view.ViewConfig nor have a +view-config for a page nested into them (like Pages.Wizard1.Step1). If +it isn’t used explicitly, it gets added automatically (so you can query +the meta-data at runtime even in cases you haven’t placed the +annotations explicitly). @View allows to customize a bit more and it +also gets added automatically if it isn’t used explicitly. Whereas +@Folder gets added to all nested interfaces (above a view-config class +- like Pages and Pages.Wizard1), @View only gets added to classes +which in-/directly inherit from +org.apache.deltaspike.core.api.config.view.ViewConfig (like +Pages.Wizard1.Step1).

+
+
+

That means at runtime the following two configs lead to the same.

+
+
+
+
public interface Pages
+{
+    interface Wizard1
+    {
+        class Step1 implements ViewConfig { }
+    }
+}
+
+//leads to the same as
+
+@Folder
+public interface Pages
+{
+    @Folder
+    interface Wizard1
+    {
+        @View
+        class Step1 implements ViewConfig { }
+    }
+}
+
+
+
+

The example above leads to the following paths:

+
+
+
    +
  • +

    /pages/

    +
    • +
  • +

    /pages/wizard1

    +
    • +
  • +

    /pages/wizard1/step1.xhtml

    +
    • +
+
+
+

To customize it you can use @Folder#name, @View#basePath, +@View#name and @View#extension (or you register custom +`NameBuilder`s inline or globally).

+
+
+
@Folder#name
+
+

The rules are pretty simple. You will get what you write. There are only +two additional features:

+
+
+
    +
  • +

    You don’t have to care about duplicated '/' (e.g. /folder1//folder2/step1.xhtml would get corrected auto. to /folder1/folder2/step1.xhtml)

    +
    • +
  • +

    With "." at the beginning (e.g. "./") you can keep the path before.

    +
    • +
+
+
+

The following example

+
+
+
+
interface Pages
+{
+    @Folder(name = "/w1/")
+    interface Wizard1
+    {
+        class Step1 implements ViewConfig { }
+    }
+
+    @Folder(name = "./w2/")
+    interface Wizard2 extends ViewConfig
+    {
+        class Step1 implements Wizard2 { }   //ViewConfig is inherited indirectly
+    }
+}
+
+
+
+

leads to the following paths:

+
+
+
    +
  • +

    /pages/

    +
    • +
  • +

    /w1/

    +
    • +
  • +

    /w1/step1.xhtml

    +
    • +
  • +

    /pages/w2/step1.xhtml

    +
    • +
+
+
+
+
@View
+
+

The same naming rules apply to @View#basePath. However, it’s only +valid to be used at view-config nodes which represent pages (→ classes +and not interfaces). On interfaces always use @Folder +(@View#basePath will get ignored there).

+
+
+
+
interface Pages
+{
+    interface Wizard1
+    {
+        @View //optional
+        class Step1 implements ViewConfig { }
+
+        @View(basePath = "/")
+        class Step2 implements ViewConfig { }
+
+        @View(basePath = "./") //or just "."
+        class Step3 implements ViewConfig { }
+
+        @View(basePath = "/w1/")
+        class Step4 implements ViewConfig { }
+
+        @View(basePath = "./w1/")
+        class Step5 implements ViewConfig { }
+    }
+}
+
+
+
+

leads to the following paths:

+
+
+
    +
  • +

    /pages

    +
    • +
  • +

    /pages/wizard1/

    +
    • +
  • +

    /pages/wizard1/step1.xhtml

    +
    • +
  • +

    /step2.xhtml

    +
    • +
  • +

    /pages/wizard1/step3.xhtml

    +
    • +
  • +

    /w1/step4.xhtml

    +
    • +
  • +

    /pages/wizard/w1/step5.xhtml

    +
    • +
+
+
+

and depending on additional meta-data you would like to inherit (e.g. +@View(navigation = REDIRECT)), you can also use:

+
+
+
+
@View(navigation = REDIRECT)
+interface Pages extends ViewConfig
+{
+    interface Wizard1 extends Pages
+    {
+        @View
+        class Step1 implements Wizard1 { }
+
+        @View(basePath = "/")
+        class Step2 implements Wizard1 { }
+
+        @View(basePath = "./")
+        class Step3 implements Wizard1 { }
+
+        @View(basePath = "/w1/")
+        class Step4 implements Wizard1 { }
+
+        @View(basePath = "./w1/")
+        class Step5 implements Wizard1 { }
+    }
+}
+
+
+
+

It leads to the same paths, but in addition @View#navigation gets +inherited along the inheritance path.

+
+
+
+
+

Navigation Parameters

+
+

Since the view-config is static, an approach to add parameters is +needed. The following part shows different possibilities to add +parameters which end up in the final URL after '?' (in case of the +integration with JSF). It isn’t needed to add all (types of) parameters +that way. Some get added autom. based on special meta-data (e.g. +@View#navigation and @View#viewParams). Instead of adding +"faces-redirect=true" manually it’s done for you as soon as you are +using @View(navigation = REDIRECT). The same goes for +"includeViewParams=true" and @View(viewParams = INCLUDE).

+
+
+
+

Static Configuration via @NavigationParameter

+
+

In some cases it’s needed to add an information in any case. So you can +annotate the view-config class with @NavigationParameter. Supported +values are static strings or EL-expressions.

+
+
+
+
public interface Pages extends ViewConfig
+{
+    @NavigationParameter(key = "param1", value = "staticValue1")
+    class Index implements Pages { }
+
+    @NavigationParameter.List({
+        @NavigationParameter(key = "param1", value = "staticValue1"),
+        @NavigationParameter(key = "param2", value = "#{myBean.property1}")
+    })
+    class Overview implements Pages { }
+}
+
+
+
+

Instead of using parameters in any case, it’s also possible to configure +them statically for particular methods:

+
+
+
+
@Model
+public class PageBean
+{
+    @NavigationParameter(key = "param2", value = "#{myBean.property1}")
+    public Class<? extends ViewConfig> actionMethod1()
+    {
+        return SimplePageConfig.class;
+    }
+
+    @NavigationParameter.List({
+        @NavigationParameter(key = "param1", value = "staticValue1"),
+        @NavigationParameter(key = "param2", value = "staticValue2")
+    })
+    public Class<? extends ViewConfig> actionMethod2()
+    {
+        return SimplePageConfig.class;
+    }
+}
+
+
+
+
Dynamic Configuration via NavigationParameterContext
+
+

Instead of using parameters in a static fashion (as shown above), it’s +also possible to add them dynamically (e.g. in case of special +conditions).

+
+
+
+
@Named
+@SessionScoped
+public class PageBean
+{
+    private int currentValue = -10;
+
+    @Inject
+    private NavigationParameterContext navigationParameterContext;
+
+    public Class<? extends ViewConfig> actionMethod()
+    {
+        currentValue++;
+
+        if (currentValue >= 0)
+        {
+            this.navigationParameterContext.addPageParameter("cv", this.currentValue);
+        }
+        return SimplePageConfig.class;
+    }
+}
+
+
+
+
+
+

Security Integration via @Secured

+
+

This annotation is a custom view-meta-data provided by the +Security-module which allows to integrate 3rd party frameworks (or +custom approaches) to secure pages as well as whole folders. You can +annotate specific parts or a marker-interface. +CustomAccessDecisionVoter used in the following example can be any +implementation of +org.apache.deltaspike.security.api.authorization.AccessDecisionVoter +and needs to be a std. CDI bean which means you can use +dependecy-injection to trigger any kind of security check. All parts +which inherit from SecuredPages (Pages.Admin, Pages.Admin.Index +and Pages.Admin.Home) are protected by CustomAccessDecisionVoter.

+
+
+

(It’s easy to check this hierarchy in a modern Java-IDE. Only for +displaying the final meta-data for every node in the IDE a special +plug-in would be needed.)

+
+
+
+
@Secured(CustomAccessDecisionVoter.class)
+public interface SecuredPages {}
+
+@View(navigation = REDIRECT)
+public interface Pages extends ViewConfig
+{
+    class Index implements Pages { }
+
+    interface Admin extends Pages, SecuredPages
+    {
+        class Index implements Admin { }
+
+        @View(navigation = FORWARD)
+        class Home implements Admin { }
+    }
+}
+
+
+
+

For sure it’s also possible to use it without a special interface. In +this case you would need:

+
+
+
+
@View(navigation = REDIRECT)
+public interface Pages extends ViewConfig
+{
+    class Index implements Pages { }
+
+    @Secured(CustomAccessDecisionVoter.class)
+    interface Admin extends Pages
+    {
+        class Index implements Admin { }
+
+        @View(navigation = FORWARD)
+        class Home implements Admin { }
+    }
+}
+
+
+
+

or:

+
+
+
+
@View(navigation = REDIRECT)
+public interface Pages extends ViewConfig
+{
+    class Index implements Pages { }
+
+    interface Admin extends Pages
+    {
+        @Secured(CustomAccessDecisionVoter.class)
+        class Index implements Admin { }
+
+        @Secured(CustomAccessDecisionVoter.class)
+        @View(navigation = FORWARD)
+        class Home implements Admin { }
+    }
+}
+
+
+
+
+

View-Controller Callbacks via @ViewControllerRef

+
+

This annotation is a custom view-meta-data provided by the JSF-module +which allows to configure beans which should act as view-controllers. +That means they can use view-controller callbacks like @InitView, +@PreViewAction, @PreRenderView and @PostRenderView. The following +example shows the usage of @PreRenderView.

+
+
+
+
//@View //optional
+@ViewControllerRef(MyPageController.class)
+public class MyPage implements ViewConfig
+{
+}
+
+@Model
+public class MyPageController
+{
+    @PreRenderView
+    protected void load()
+    {
+        //...
+    }
+}
+
+
+
+

Since v0.7 it’s possible to observe exceptions thrown by a +@PreRenderView callback and use your configured Default-Error-View to +display the exception.

+
+
+

Example:

+
+
+
+
@ExceptionHandler
+public class ErrorViewAwareExceptionHandler {
+    @Inject
+    private ViewConfigResolver viewConfigResolver;
+
+    public void onIllegalStateException(@Handles ExceptionEvent<IllegalStateException> e)
+    {
+        FacesContext facesContext = FacesContext.getCurrentInstance();
+
+        String viewId = viewConfigResolver.getDefaultErrorViewConfigDescriptor().getViewId();
+        UIViewRoot viewRoot = facesContext.getApplication().getViewHandler().createView(facesContext, viewId);
+        facesContext.setViewRoot(viewRoot);
+        //... - e.g.: store the exception in a page-bean for the default-error-view
+    }
+}
+
+
+
+
+

Referencing Views via @ViewRef

+
+

With @ViewControllerRef#value you can annotate a view-config class to +bind (/reference) a controller to it. @ViewRef#config allows the same +in the other direction. Use an existing view-config to reference one or +many view/s.

+
+
+

That means e.g.

+
+
+
+
public interface Pages extends ViewConfig
+{
+    class Index implements Pages { }
+}
+
+@ViewRef(Pages.Index.class)
+//...
+public class IndexController implements Serializable
+{
+    @PreRenderView
+    protected void preRenderView()
+    {
+        //...
+    }
+
+    //...
+}
+
+
+
+

leads to the invocation of the pre-render-view logic before +/pages/page1.xhtml gets rendered (and it won’t be called for other +pages).

+
+
+
+

Using the (optional) ViewNavigationHandler

+
+

With JSF you typically navigate with the action-method bound to a +command-component. However, also JSF supports manual navigation via +javax.faces.application.NavigationHandler. With +ViewNavigationHandler DeltaSpike provides an equivalent optimized for +type-safe view-configs which is easier to use (and can be used also for +other (supported) view technology).

+
+
+

A simple example is:

+
+
+
+
public interface Pages {
+    class Index implements ViewConfig { }
+}
+
+@Model
+public class AnyController
+{
+    @Inject
+    private ViewNavigationHandler viewNavigationHandler;
+
+    public void anyMethod()
+    {
+        //navigates to /pages/index.xhtml
+        this.viewNavigationHandler.navigateTo(Pages.Index.class);
+    }
+}
+
+
+
+

Also in this case (optional) meta-data will be used for the navigation +process, since ViewNavigationHandler just delegates to the active +navigation-handler (of JSF).

+
+
+
+

Configuring a Default Error-View

+
+

It’s possible to mark one view-config class as default error-view. That +means in case of errors it will be used as navigation target +automatically. Furthermore, it’s also possible to use it in your code +instead of hardcoding your error-view across the whole application.

+
+
+

In case of

+
+
+
+
public interface Pages {
+    class Index implements ViewConfig { }
+
+    class CustomErrorPage extends DefaultErrorView { }
+}
+
+
+
+

it’s possible to navigate with DefaultErrorView.class instead of +hardcoding it to Pages.CustomErrorPage.class.

+
+
+
+
@Model
+public class PageController
+{
+    public Class<? extends ViewConfig> actionWithoutError()
+    {
+        return Pages.Index.class;
+    }
+
+    public Class<? extends ViewConfig> actionWithError()
+    {
+        //navigates to the view which is configured as default error-view
+        return DefaultErrorView.class;
+    }
+}
+
+
+
+

If you are outside of an action-method you can also use it in +combination with ViewNavigationHandler.

+
+
+
+
@Model
+public class AnyController
+{
+    @Inject
+    private ViewNavigationHandler viewNavigationHandler;
+
+    public void anyMethod()
+    {
+        //navigates to the view which is configured as default error-view
+        this.viewNavigationHandler.navigateTo(DefaultErrorView.class);
+    }
+}
+
+
+
+

However, in case of JSF you have to ensure that you are at a valid point +in the JSF request-lifecycle for a navigation, because invocation gets +transformed to a std. (implicit) JSF navigation.

+
+
+
+

Using @Matches

+
+

This annotation is currently not integrated. [TODO]

+
+
+
+

Using ViewConfigResolver

+
+

If you would like to query view-meta-data yourself (for whatever +reason), you can do that with ViewConfigResolver.

+
+
+
+
@RequestScoped
+public class ApiDemoBean
+{
+    @Inject
+    private ViewConfigResolver viewConfigResolver;
+
+    public String getViewId(Class<? extends ViewConfig> viewConfigClass)
+    {
+        return viewConfigResolver.getViewConfigDescriptor(viewConfigClass).getViewId(); //or #getPath
+    }
+
+    public String getPath(Class pathConfigClass)
+    {
+        return viewConfigResolver.getConfigDescriptor(pathConfigClass).getPath();
+    }
+
+    public List<ConfigDescriptor<?>> getAllFolderDescriptors()
+    {
+        return viewConfigResolver.getConfigDescriptors();
+    }
+
+    public List<ViewConfigDescriptor> getAllPageDescriptors()
+    {
+        return viewConfigResolver.getViewConfigDescriptors();
+    }
+
+    public ViewConfigDescriptor getCurrentViewConfig()
+    {
+        return viewConfigResolver.getViewConfigDescriptor(FacesContext.getCurrentInstance().getViewRoot().getViewId());
+    }
+
+    public Class<? extends ViewConfig> getCurrentViewConfigClass()
+    {
+        return viewConfigResolver.getViewConfigDescriptor(FacesContext.getCurrentInstance().getViewRoot().getViewId()).getConfigClass();
+    }
+    //...
+}
+
+
+
+

For folders it’s optional to implement the ViewConfig interface, +therefore you see 2 different types of API. #getConfigDescriptor as +the general API and #getViewConfigDescriptor which is specific for +pages (which have to implement the ViewConfig interface).

+
+
+

Besides translating a config class to the final path of the folder or +page, it’s possible to get the implicitly as well as explicitly +configured (view-)meta-data and get and/or execute configured callbacks.

+
+
+
+
+

Advanced API usages

+
+

Creating Custom Meta-Data via @ViewMetaData

+
+

This meta-annotation allows to create custom view-meta-data which can be +used for view-configs. Per default meta-data of a lower level overrides +meta-data on a higher level which has the same type. That can be +customized via annotating the final annotation as a whole via +@Aggregated(true).

+
+
+
+
@ViewMetaData
+@interface InfoPage
+{
+}
+
+
+
+

By just using @InfoPage in view-configs, it can be queried via:

+
+
+
+
@Inject
+private ViewConfigResolver viewConfigResolver;
+//...
+
+ViewConfigDescriptor viewConfigDescriptor = viewConfigResolver.getViewConfigDescriptor(Pages.Index.class);
+List<InfoPage> metaDataList = viewConfigDescriptor.getMetaData(InfoPage.class)
+
+
+
+
+

Creating Custom Meta-Data via @Stereotype

+
+

Like with CDI itself you can encapsulate multiple view meta-data +annotation in one annotation.

+
+
+

e.g.:

+
+
+
+
@Target({TYPE})
+@Retention(RUNTIME)
+
+@Stereotype
+@Secured(CustomAccessDecisionVoter.class) //view meta-data #1
+@View(navigation = REDIRECT) //view meta-data #2
+@interface MySecuredView {}
+
+
+
+

Instead of using the same combination of annotations in multiple places, +you can use the stereotype annotation. If you query the meta-data at +runtime (see ViewConfigDescriptor#getMetaData), you can access +@Secured as well as @View (in the example above). however, you won’t +see @MySecuredView itself at runtime, because stereotype annotations +are per default transparent.

+
+
+

Since v1.0.1+ it’s possible to access such stereotype annotations as +well, once you annotate them with @ViewMetaData.

+
+
+
+

Creating Custom Callbacks via @ViewMetaData

+
+

Via a custom ConfigPreProcessor it’s possible to register custom +callbacks dynamically. The following listing shows a view-config which +adds a simple callback including the corresponding ConfigPreProcessor +and ExecutableCallbackDescriptor.

+
+
+
+
@ViewMetaData(preProcessor = MySecured.AnnotationPreProcessor.class)
+public @interface MySecured
+{
+    Class<? extends TestAccessDecisionVoter>[] value();
+
+    class AnnotationPreProcessor implements ConfigPreProcessor<MySecured>
+    {
+        @Override
+        public MySecured beforeAddToConfig(MySecured metaData, ViewConfigNode viewConfigNode)
+        {
+            List<CallbackDescriptor> descriptors = viewConfigNode.getCallbackDescriptors(MySecured.class);
+            descriptors.add(new Descriptor(metaData.value(), DefaultCallback.class));
+            return metaData;
+        }
+    }
+
+    static class Descriptor extends ExecutableCallbackDescriptor<Set<String>>
+    {
+        public Descriptor(Class[] beanClasses, Class<? extends Annotation> callbackMarker)
+        {
+            super(beanClasses, callbackMarker);
+        }
+
+        public List<Set<String>> execute(String param1, String param2)
+        {
+            return super.execute(param1, param2);
+        }
+    }
+}
+
+
+
+

By just using @MySecured in view-configs, it can be queried and +executed via:

+
+
+
+
@Inject
+private ViewConfigResolver viewConfigResolver;
+//...
+ViewConfigDescriptor viewConfigDescriptor = viewConfigResolver.getViewConfigDescriptor(Pages.Secured.Index.class);
+
+List<Set<String> /*return type of one callback*/> callbackResult =
+    viewConfigDescriptor.getExecutableCallbackDescriptor(MySecured.class, MySecured.Descriptor.class)
+        .execute("param1", "param2");
+
+
+
+

It’s also possible do register different callback-types per +view-meta-data. An example can be found at ViewControllerRef which +registers different callback-types for InitView, PreViewAction, +PreRenderView and PostRenderView. In this case it’s needed to use +the type of the callback (= class of the annotation) as additional +parameter for #getExecutableCallbackDescriptor.

+
+
+
+

Creating Custom inline Meta-Data via @InlineViewMetaData

+
+

This annotation can be used for view-meta-data which can be placed on +other classes than view-config-classes. It’s used e.g. for @ViewRef. +Via a TargetViewConfigProvider it’s possible to point to the +view-config the meta-data should get applied to and via +InlineMetaDataTransformer it’s possible to convert it to a different +meta-data-representation (which allows that at runtime you only have to +support one side since the inline-meta-data was converted to the same +meta-data representation which is used for the normal view-meta-data).

+
+
+
+
+

Path-Validation

+
+

DeltaSpike (after v0.5) validates your configs out-of-the-box. The +application will fail to start, if there is an invalid config (e.g. a +view-config without a corresponding view). Right now the validation is +restricted to folders and view-ids with .xhtml or .jsp as suffix. Other +view-ids (e.g. *.faces) don’t get checked. In such cases a custom +validator can be used (e.g. based on ViewConfigPathValidator).

+
+
+

To disable the view-config (path) validation, add a ClassDeactivator +which restricts +org.apache.deltaspike.jsf.impl.config.view.ViewConfigPathValidator.

+
+
+
+

View-Config SPI

+
+

ConfigDescriptorValidator

+
+

Allows to validate the final view-config descriptors before they get +deployed. Since the config-descriptor contains e.g. the final path, it’s +also possible to validate if the corresponding file exists. Use +@ViewConfigRoot to configure 1-n validators.

+
+
+
+

ConfigNodeConverter

+
+

Allows to provide custom strategies to process the nodes of the built +config-tree. Use @ViewConfigRoot to configure a custom converter.

+
+
+
+

ConfigPreProcessor

+
+

Allows to change the found meta-data (e.g. replace default values, +callbacks,…​) or the ViewConfigNode itself.

+
+
+
+

InlineMetaDataTransformer

+
[... 678 lines stripped ...]