How do I process GET query string URL parameters in backing bean on page load?

Question

I've read how to send parameters using JSF but what if the user types their companyId in the URL when accessing their login page? For example,

http://my.company.url/productName/login.faces?companyId=acme.

The way we do it now, there is a bit of scriptlet code that grabs the value from the request and then set it in the session. That parameter changes their look and feel starting from the login page forward so each customer could have a different login page view. We are using extjs until I switch over to JSF.

Is there a way to do that using JSF 2 or perhaps PrimeFaces?

Solution 1

Yes, you can use the <f:viewParam> to set a request parameter as a managed bean property.

<f:metadata>
    <f:viewParam name="companyId" value="#{bean.companyId}" />
</f:metadata>

You can if necessary invoke a bean action using <f:viewAction> (JSF 2.2+ only) or <f:event type="preRenderView">.

<f:metadata>
    <f:viewParam name="companyId" value="#{bean.companyId}" />
    <f:viewAction action="#{bean.onload}" />
</f:metadata>

When using <f:viewAction> you can even return a navigation outcome.

public String onload() {
    // ...

    return "somepage";
}

When not on JSF 2.2 yet, you can use ExternalContext#redirect() for that. See also among others How to perform navigation in preRenderView listener method.

Note that this is not specific to PrimeFaces. It's just part of standard JSF. PrimeFaces is merely a component library which provides enhanced ajax and skinnability support.

See also:

• What can <f:metadata>, <f:viewParam> and <f:viewAction> be used for?
• Communication in JSF 2.0 - Processing GET request parameters
• @ManagedProperty with request parameter not set in a @Named bean

Solution 2

url paramters can also be treated as request parameters so you can also access through

FacesContext.getCurrentInstance().getExternalContext().getRequestParameterMap()

Solution 3

There is a utility library, OmniFaces which does this out of the box.

@Inject @Param
private String key;

@Inject @Param
private Long id;

Solution 4

You can use the request.getQueryString() if you want to get full query parameter string.

View more solutions

Comments

[BalusC]

They are request parameters. The way as you proposed however allows less fine grained conversion/validation which may result in lot of unnecessary boilerplate code in backing bean. See also the "See also" links in the accepted answer.

[Ced]

I used to use PostConstruct for this type of things (and DB access). The problem I just found out is that on requestscoped beans, the method will be recalled on ajax req that have nothing to do with said bean. That is not the case with viewAction. For anyone wondering why : stackoverflow.com/questions/24490152/…

[Arash]

If i use <f:viewParam>, there is no need for context.getExternalContext().getRequestParameterMap() in the ManagedBean? "... you can even return a navigation outcome." Is it redirection?