001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.core.request.mapper;
018
019import org.apache.wicket.request.component.IRequestablePage;
020import org.apache.wicket.request.resource.ResourceReferenceRegistry;
021
022/**
023 * Utility interface for providing and creating new page instances. This interface is used also to 
024 * define which segments are reserved for internal use (see methods {@link #getNamespace()}, {@link #getPageIdentifier()},
025 * {@link #getBookmarkableIdentifier()} and {@link #getResourceIdentifier()}).
026 *
027 * @author Matej Knopp
028 */
029public interface IMapperContext extends IPageSource
030{
031        /**
032         * @return the namespace for Wicket URLs.
033         */
034        String getNamespace();
035
036        /**
037         * @return identifier for non bookmarkable URLs
038         */
039        String getPageIdentifier();
040
041        /**
042         * @return identifier for bookmarkable URLs
043         */
044        String getBookmarkableIdentifier();
045
046        /**
047         * @return identifier for resources
048         */
049        String getResourceIdentifier();
050
051        /**
052         * @return {@link ResourceReferenceRegistry}
053         */
054        ResourceReferenceRegistry getResourceReferenceRegistry();
055
056        /**
057         * Returns the home page class.
058         *
059         * @return home page class
060         */
061        Class<? extends IRequestablePage> getHomePageClass();
062}