org.apache.tapestry5.services.InvalidationEventHub Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tapestry-core Show documentation

Central module for Tapestry, containing interfaces to the Java Servlet API and all core services and components.

There is a newer version: 5.8.6

// Copyright 2006, 2007, 2008 The Apache Software Foundation
//
// 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 org.apache.tapestry5.services;

/**
 * An object which manages a list of {@link org.apache.tapestry5.services.InvalidationListener}s. There are multiple
 * event hub services implementing this interface, each with a specific marker annotation; each can register listeners
 * and fire events; these are based on the type of resource that has been invalidated. Tapestry has built-in support
 * for:  message catalog resources 
{@link org.apache.tapestry5.services.ComponentMessages} marker annotation
 * 
component templates 
{@link org.apache.tapestry5.services.ComponentTemplates}  marker annotation 
component
 * classes 
{@link org.apache.tapestry5.services.ComponentClasses} marker annotation 
 *
 * @since 5.1.0.0
 */
public interface InvalidationEventHub
{
    /**
     * Adds a listener, who needs to know when an underlying resource of a given category has changed (so that the
     * receiver may discard any cached data that may  have been invalidated).
     */
    void addInvalidationListener(InvalidationListener listener);
}