Channel.java

/**
 *   GRANITE DATA SERVICES
 *   Copyright (C) 2006-2015 GRANITE DATA SERVICES S.A.S.
 *
 *   This file is part of the Granite Data Services Platform.
 *
 *   Granite Data Services 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 2.1 of the License, or (at your option) any later version.
 *
 *   Granite Data Services 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 library; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
 *   USA, or see <http://www.gnu.org/licenses/>.
 */
package org.granite.gravity;

import java.security.Principal;
import java.util.Collection;


import flex.messaging.messages.AsyncMessage;

/**
 * @author Franck WOLFF
 */
public interface Channel {

    public String getId();
    
    public String getClientType();
    
    public boolean isAuthenticated();
    public boolean isConnected();

    public Principal getUserPrincipal();
    public void setUserPrincipal(Principal principal);
    
    public GravityInternal getGravity();
    
    public ChannelFactory<?> getFactory();

    public Subscription addSubscription(String destination, String subTopicId, String subscriptionId, boolean noLocal);
    public Collection<Subscription> getSubscriptions();
    public Subscription removeSubscription(String subscriptionId);

	public void publish(AsyncPublishedMessage message) throws MessagePublishingException;
	public boolean hasPublishedMessage();
	public boolean runPublish();
	
	public void receive(AsyncMessage message) throws MessageReceivingException;
	public boolean hasReceivedMessage();
	public boolean runReceive();
	public boolean runReceived(AsyncHttpContext asyncHttpContext);
    
	public void close(boolean timeout);
    public void destroy(boolean timeout);
}