de.novanic.eventservice.client.event.service.EventServiceAsync Maven / Gradle / Ivy
The newest version!
/*
* GWTEventService
* Copyright (c) 2011 and beyond, strawbill UG (haftungsbeschr?nkt)
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 3 of
* the License, or (at your option) any later version.
* Other licensing for GWTEventService may also be possible on request.
* Please view the license.txt of the project for more information.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package de.novanic.eventservice.client.event.service;
import de.novanic.eventservice.client.config.EventServiceConfigurationTransferable;
import de.novanic.eventservice.client.event.filter.EventFilter;
import de.novanic.eventservice.client.event.Event;
import de.novanic.eventservice.client.event.domain.Domain;
import de.novanic.eventservice.client.event.DomainEvent;
import de.novanic.eventservice.client.event.listener.unlisten.UnlistenEvent;
import de.novanic.eventservice.client.event.listener.unlisten.UnlistenEventListener;
import com.google.gwt.user.client.rpc.AsyncCallback;
import java.util.Set;
import java.util.List;
/**
* EventService is the server side interface to register listen requests for domains and to add events.
*
* @author sstrohschein
*
Date: 05.06.2008
*
Time: 19:07:07
*/
public interface EventServiceAsync
{
/**
* Initializes the {@link EventService}.
*/
void initEventService(AsyncCallback async);
/**
* Register listen for a domain.
*
* @param aDomain domain to listen to
*/
void register(Domain aDomain, AsyncCallback async);
/**
* Register listen for a domain.
*
* @param aDomain domain to listen to
* @param anEventFilter EventFilter to filter events
*/
void register(Domain aDomain, EventFilter anEventFilter, AsyncCallback async);
/**
* Register listen for a domain.
*
* @param aDomains domains to listen to
*/
void register(Set aDomains, AsyncCallback async);
/**
* Register listen for domains.
*
* @param aDomains domains to listen to
* @param anEventFilter EventFilter to filter events (applied to all domains)
*/
void register(Set aDomains, EventFilter anEventFilter, AsyncCallback async);
/**
* Registers an {@link de.novanic.eventservice.client.event.listener.unlisten.UnlistenEvent} which is triggered on a
* timeout or when a user/client leaves a {@link de.novanic.eventservice.client.event.domain.Domain}. An
* {@link de.novanic.eventservice.client.event.listener.unlisten.UnlistenEvent} is hold at the server side and can
* contain custom data. Other users/clients can use the custom data when the event is for example triggered by a timeout.
*
* @param anUnlistenScope scope of the unlisten events to receive
* @param anUnlistenEvent {@link de.novanic.eventservice.client.event.listener.unlisten.UnlistenEvent} which should
* be transferred to other users/clients when a timeout occurs or a domain is leaved.
*/
void registerUnlistenEvent(UnlistenEventListener.Scope anUnlistenScope, UnlistenEvent anUnlistenEvent, AsyncCallback async);
/**
* Registers an {@link de.novanic.eventservice.client.event.filter.EventFilter} for the domain.
*
* @param aDomain domain to register the EventFilter to
* @param anEventFilter EventFilter to filter events for the domain
*/
void registerEventFilter(Domain aDomain, EventFilter anEventFilter, AsyncCallback async);
/**
* Deregisters the {@link de.novanic.eventservice.client.event.filter.EventFilter} of the domain.
*
* @param aDomain domain to drop the EventFilters from
*/
void deregisterEventFilter(Domain aDomain, AsyncCallback async);
/**
* Returns the EventFilter for the user domain combination.
*
* @param aDomain domain
* @return EventFilter for the domain
*/
void getEventFilter(Domain aDomain, AsyncCallback async);
/**
* The listen method returns all events for the user (events for all domains where the user is registered and user
* specific events). If no events are available, the method waits a defined time before the events are returned.
* The client side calls the method with a defined interval to receive all events. If the client don't call the
* method in the interval, the user will be removed from the EventRegistry. The timeout time and the waiting time
* can be configured with EventServiceConfiguration/-Factory (server side) and initialized with the init method of
* EventRegistryFactory (server side).
*
* @return list of events
*/
void listen(AsyncCallback> async);
/**
* Unlisten for events (for the current user) in all domains (deregisters the user from all domains).
*/
void unlisten(AsyncCallback async);
/**
* Unlisten for events
*
* @param aDomain the domain to unlisten
*/
void unlisten(Domain aDomain, AsyncCallback async);
/**
* Unlisten for events (for the current user) in the domains and deregisters the user from the domains.
*
* @param aDomains set of domains to unlisten
*/
void unlisten(Set aDomains, AsyncCallback async);
/**
* Checks if the user is registered for event listening.
*
* @param aDomain domain to check
* @return true when the user is registered for listening, otherwise false
*/
void isUserRegistered(Domain aDomain, AsyncCallback async);
/**
* Adds an event for all users in the domain.
*
* @param aDomain domain to add the event
* @param anEvent event to add
*/
void addEvent(Domain aDomain, Event anEvent, AsyncCallback async);
/**
* Adds an event only for the current user.
*
* @param anEvent event to add to the user
*/
void addEventUserSpecific(Event anEvent, AsyncCallback async);
/**
* Returns the domain names, where the user is listening to
*
* @return collection of domain names
*/
void getActiveListenDomains(AsyncCallback> async);
}