jp.xet.uncommons.wicket.fixedurl.FixedUrlHomePageMapper.java Source code

Introduction

Here is the source code for jp.xet.uncommons.wicket.fixedurl.FixedUrlHomePageMapper.java

Source

/*
 * Copyright 2012 Daisuke Miyamoto.
 * Created on 2012/03/25
 *
 * Licensed 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 jp.xet.uncommons.wicket.fixedurl;

import java.util.List;

import org.apache.wicket.Application;
import org.apache.wicket.Page;
import org.apache.wicket.markup.resolver.AutoLinkResolver;
import org.apache.wicket.markup.resolver.AutoLinkResolver.IAutolinkResolverDelegate;
import org.apache.wicket.markup.resolver.IComponentResolver;
import org.apache.wicket.request.IRequestMapper;
import org.apache.wicket.request.Request;
import org.apache.wicket.request.Url;
import org.apache.wicket.request.component.IRequestablePage;
import org.apache.wicket.request.mapper.HomePageMapper;
import org.apache.wicket.request.mapper.ICompoundRequestMapper;
import org.apache.wicket.request.mapper.parameter.IPageParametersEncoder;
import org.apache.wicket.util.ClassProvider;
import org.apache.wicket.util.lang.Args;

/**
 * TODO for daisuke
 * 
 * @since 1.2
 * @version $Id$
 * @author daisuke
 */
public class FixedUrlHomePageMapper extends FixedUrlMountedMapper {

    /**
     * TODO for daisuke
     * 
     * @param application {@link Application}
     * @throws NullPointerException ?{@code null}???
     * @since 1.2
     */
    public static void replaceHomePageMapper(final Application application) {
        Args.notNull(application, "application");
        ICompoundRequestMapper mappers = application.getRootRequestMapperAsCompound();
        IRequestMapper homePageMapper = null;
        for (IRequestMapper mapper : mappers) {
            if (mapper instanceof HomePageMapper) {
                homePageMapper = mapper;
                break;
            }
        }
        if (homePageMapper != null) {
            mappers.remove(homePageMapper);
        }
        mappers.add(new FixedUrlHomePageMapper(new ClassProvider<Page>(null) {

            @Override
            public Class<Page> get() {
                @SuppressWarnings("unchecked")
                Class<Page> homePage = (Class<Page>) application.getHomePage();
                return homePage;
            }
        }));
    }

    /**
     * FixedUrlMountedMapper??a??? ?reload ?
     * 
     * @param application {@link Application}
     * @throws IllegalArgumentException ?{@code null}???
     * @since 1.5
     * @deprecated use {@link FixedUrlMountedMapper#initialize(org.apache.wicket.settings.IPageSettings)}
     */
    @Deprecated
    public static void wrapAutoLinkResolver(final Application application) {
        Args.notNull(application, "application");
        List<IComponentResolver> resolvers = application.getPageSettings().getComponentResolvers();
        for (IComponentResolver resolver : resolvers) {
            if (resolver instanceof AutoLinkResolver) {
                AutoLinkResolver autoLinkResolver = (AutoLinkResolver) resolver;
                IAutolinkResolverDelegate delegateForAElement = autoLinkResolver.getAutolinkResolverDelegate("a");
                IAutolinkResolverDelegate newDelegate = new ForceReloadAutolinkResolverDelegate(
                        delegateForAElement);
                autoLinkResolver.addTagReferenceResolver("a", "href", newDelegate);
            }
        }
    }

    /**
     * ??
     * 
     * @param pageClass
     */
    public FixedUrlHomePageMapper(Class<? extends IRequestablePage> pageClass) {
        super("/", pageClass);
    }

    /**
     * ??
     * 
     * @param pageClass
     * @param pageParametersEncoder
     */
    public FixedUrlHomePageMapper(Class<? extends IRequestablePage> pageClass,
            IPageParametersEncoder pageParametersEncoder) {
        super("/", pageClass, pageParametersEncoder);
    }

    /**
     * ??
     * 
     * @param pageClassProvider
     */
    public FixedUrlHomePageMapper(ClassProvider<? extends IRequestablePage> pageClassProvider) {
        super("/", pageClassProvider);
    }

    /**
     * ??
     * 
     * @param pageClassProvider
     * @param pageParametersEncoder
     */
    public FixedUrlHomePageMapper(ClassProvider<? extends IRequestablePage> pageClassProvider,
            IPageParametersEncoder pageParametersEncoder) {
        super("/", pageClassProvider, pageParametersEncoder);
    }

    /**
     * Use this mapper as a last option. Let all other mappers to try to handle the request
     * 
     * @see org.apache.wicket.request.mapper.MountedMapper#getCompatibilityScore(org.apache.wicket.request.Request)
     */
    @Override
    public int getCompatibilityScore(Request request) {
        return Integer.MIN_VALUE + 1;
    }

    /**
     * Matches only when there are no segments/indexed parameters
     * 
     * @see org.apache.wicket.request.mapper.AbstractBookmarkableMapper#parseRequest(org.apache.wicket.request.Request)
     */
    @Override
    protected UrlInfo parseRequest(Request request) {
        // get canonical url
        final Url url = request.getUrl().canonical();

        if (url.getSegments().size() > 0) {
            // home page cannot have segments/indexed parameters
            return null;
        }

        return super.parseRequest(request);
    }
}