org.apache.wicket.resource.DynamicJQueryResourceReference.java Source code

Introduction

Here is the source code for org.apache.wicket.resource.DynamicJQueryResourceReference.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.wicket.resource;

import org.apache.wicket.MetaDataKey;
import org.apache.wicket.Session;
import org.apache.wicket.protocol.http.ClientProperties;
import org.apache.wicket.protocol.http.WebSession;
import org.apache.wicket.protocol.http.request.WebClientInfo;
import org.apache.wicket.request.cycle.RequestCycle;

/**
 * A resource reference that calculates which version of jQuery JavaScript library to use depending
 * on the user agent. For IE 6/7/8 jQuery ver. 1.x will be used, for any other browser - ver. 2.x.
 *
 * To use this resource reference do:
 * <code>
 * app.getJavaScriptLibrarySettings().setJQueryReference(new DynamicJQueryResourceReference())
 * </code>
 *
 * @since 6.9.0
 * @deprecated Internet Explorer older than version 11 is not maintained by Microsoft.
 *             Use JQuery 3.x (or 2.x) instead with:
 *             app.getJavaScriptLibrarySettings().setJQueryReference(JQueryResourceReference.getV3())
 */
@Deprecated
public class DynamicJQueryResourceReference extends JQueryResourceReference {
    private static final long serialVersionUID = 1L;

    /**
     * The key for the metadata that is used as a cache to calculate the name
     * only once
     */
    private static final MetaDataKey<String> KEY = new MetaDataKey<String>() {
    };

    public DynamicJQueryResourceReference() {
        super(VERSION_2);
    }

    @Override
    public String getName() {
        RequestCycle requestCycle = RequestCycle.get();
        String name = requestCycle.getMetaData(KEY);
        if (name == null) {
            WebClientInfo clientInfo;
            name = getVersion2();
            if (Session.exists()) {
                WebSession session = WebSession.get();
                clientInfo = session.getClientInfo();
            } else {
                clientInfo = new WebClientInfo(requestCycle);
            }
            ClientProperties clientProperties = clientInfo.getProperties();
            if (clientProperties.isBrowserInternetExplorer() && clientProperties.getBrowserVersionMajor() < 9) {
                name = getVersion1();
            }

            requestCycle.setMetaData(KEY, name);
        }
        return name;
    }

    protected String getVersion1() {
        return VERSION_1;
    }

    protected String getVersion2() {
        return VERSION_2;
    }

    @Override
    public Class<?> getScope() {
        return getClass();
    }
}