001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.poller;
016    
017    import com.liferay.portal.kernel.json.JSONArray;
018    import com.liferay.portal.kernel.json.JSONObject;
019    import com.liferay.portal.kernel.messaging.Message;
020    
021    import java.io.Serializable;
022    
023    /**
024     * @author Brian Wing Shun Chan
025     * @author Edward Han
026     */
027    public interface PollerResponse extends Serializable {
028    
029            public static final String POLLER_HINT_HIGH_CONNECTIVITY =
030                    "pollerHintHighConnectivity";
031    
032            public void close(
033                    Message message, PollerHeader pollerHeader, String portletId,
034                    String chunkId);
035    
036            public PollerHeader getPollerHeader();
037    
038            public String getPortletId();
039    
040            public boolean isEmpty();
041    
042            public void setParameter(String name, JSONArray value)
043                    throws PollerResponseClosedException;
044    
045            public void setParameter(String name, JSONObject value)
046                    throws PollerResponseClosedException;
047    
048            public void setParameter(String name, String value)
049                    throws PollerResponseClosedException;
050    
051            public JSONObject toJSONObject();
052    
053    }