001    /**
002     * Copyright (c) 2000-2013 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    /**
022     * @author Brian Wing Shun Chan
023     * @author Edward Han
024     */
025    public interface PollerResponse {
026    
027            public static final String POLLER_HINT_HIGH_CONNECTIVITY =
028                    "pollerHintHighConnectivity";
029    
030            public void close();
031    
032            public void createResponseMessage(Message message);
033    
034            public PollerHeader getPollerHeader();
035    
036            public String getPortletId();
037    
038            public boolean isEmpty();
039    
040            public void setParameter(String name, JSONArray value)
041                    throws PollerResponseClosedException;
042    
043            public void setParameter(String name, JSONObject value)
044                    throws PollerResponseClosedException;
045    
046            public void setParameter(String name, String value)
047                    throws PollerResponseClosedException;
048    
049            public JSONObject toJSONObject();
050    
051    }