| /* |
| * Copyright 2010 Google Inc. |
| * |
| * 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 com.google.gwt.requestfactory.shared; |
| |
| import com.google.gwt.event.shared.EventBus; |
| import com.google.gwt.event.shared.EventHandler; |
| import com.google.gwt.event.shared.GwtEvent; |
| import com.google.gwt.event.shared.HandlerRegistration; |
| import com.google.gwt.http.client.Response; |
| |
| /** |
| * <p> |
| * <span style="color:red">Experimental API: This class is still under rapid |
| * development, and is very likely to be deleted. Use it at your own risk. |
| * </span> |
| * </p> |
| * An event posted whenever an RPC request is sent or its response is received. |
| */ |
| public class RequestEvent extends GwtEvent<RequestEvent.Handler> { |
| |
| /** |
| * Implemented by handlers of this type of event. |
| */ |
| public interface Handler extends EventHandler { |
| void onRequestEvent(RequestEvent requestEvent); |
| } |
| |
| /** |
| * The request state. |
| */ |
| public enum State { |
| SENT, RECEIVED |
| } |
| |
| private static final Type<Handler> TYPE = new Type<Handler>(); |
| |
| public static HandlerRegistration register(EventBus eventBus, |
| RequestEvent.Handler handler) { |
| return eventBus.addHandler(TYPE, handler); |
| } |
| |
| private final State state; |
| |
| /** |
| * Will only be non-null if this is an event of type {@link State#RECEIVED}, |
| * and the RPC was successful. |
| */ |
| private final Response response; |
| |
| public RequestEvent(State state, Response response) { |
| this.state = state; |
| this.response = response; |
| } |
| |
| @Override |
| public GwtEvent.Type<Handler> getAssociatedType() { |
| return TYPE; |
| } |
| |
| public Response getResponse() { |
| return response; |
| } |
| |
| public State getState() { |
| return state; |
| } |
| |
| @Override |
| protected void dispatch(Handler handler) { |
| handler.onRequestEvent(this); |
| } |
| } |