001// Copyright 2010 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007// http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5;
016
017import org.apache.tapestry5.internal.structure.PageResetListener;
018import org.apache.tapestry5.runtime.PageLifecycleListener;
019import org.apache.tapestry5.services.ComponentEventLinkEncoder;
020
021/**
022 * Constants needed by end-user classes.
023 * 
024 * @since 5.2.0
025 */
026public class TapestryConstants
027{
028
029    /**
030     * The extension used for Tapestry component template files, <em>T</em>apestry <em>M</em>arkup <em>L</em>anguage.
031     * Template files are well-formed XML files.
032     */
033    public static final String TEMPLATE_EXTENSION = "tml";
034
035    /**
036     * Name of query parameter that is placed on "loopback" links (page render links for the same
037     * page). This mostly includes the redirects sent after a component event request. Page render
038     * requests
039     * that do <em>not</em> have the LOOPBACK query parameter will trigger a {@linkplain PageResetListener reset
040     * notification} after the initialization event; the
041     * LOOPBACK
042     * prevents this reset notification.
043     * 
044     * @since 5.2.0
045     * @see ComponentEventLinkEncoder#createPageRenderLink(org.apache.tapestry5.services.PageRenderRequestParameters)
046     * @see ComponentEventLinkEncoder#decodePageRenderRequest(org.apache.tapestry5.services.Request)
047     * @see PageResetListener
048     */
049    public static final String PAGE_LOOPBACK_PARAMETER_NAME = "t:lb";
050
051}