org.apache.wicket.atmosphere.EventSubscriptionInvoker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wicket-atmosphere Show documentation

Wicket-Atmosphere provides integration of the Atmosphere Framework in Wicket.

There is a newer version: 0.41

/*
 * 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.atmosphere;

import org.apache.wicket.Component;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.behavior.Behavior;

/**
 * Delivers events to a subscribed {@link Component} or {@link Behavior}. Implementations convey
 * {@link AtmosphereEvent#getPayload()} into an invocation of the subscription method
 * {@link EventSubscription#getMethodName()}.
 */
public interface EventSubscriptionInvoker
{
	/**
	 * 
	 * @param target
	 *            {@link AjaxRequestTarget} to which {@link EventSubscription} result should be sent
	 * @param subscription
	 *            {@link EventSubscription}
	 * @param base
	 *            {@link EventSubscription} object on which {@link EventSubscription} should be
	 *            invoked
	 * @param event
	 *            {@link AtmosphereEvent} which matches the {@link EventSubscription}'s predicates
	 * @param ajaxRequestInitializer
	 *            call {@code ajaxRequestInitializer.initialize()} before you are going to invoke
	 *            {@link EventSubscription}
	 */
	void invoke(AjaxRequestTarget target, EventSubscription subscription, Object base,
		AtmosphereEvent event, AjaxRequestInitializer ajaxRequestInitializer);
}