001    /*
002      GRANITE DATA SERVICES
003      Copyright (C) 2012 GRANITE DATA SERVICES S.A.S.
004    
005      This file is part of Granite Data Services.
006    
007      Granite Data Services is free software; you can redistribute it and/or modify
008      it under the terms of the GNU Library General Public License as published by
009      the Free Software Foundation; either version 2 of the License, or (at your
010      option) any later version.
011    
012      Granite Data Services is distributed in the hope that it will be useful, but
013      WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
014      FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License
015      for more details.
016    
017      You should have received a copy of the GNU Library General Public License
018      along with this library; if not, see <http://www.gnu.org/licenses/>.
019    */
020    
021    package org.granite.client.messaging.channel;
022    
023    import java.io.InputStream;
024    import java.net.URI;
025    
026    import org.granite.client.messaging.ResponseListener;
027    import org.granite.client.messaging.messages.RequestMessage;
028    import org.granite.client.messaging.transport.Transport;
029    import org.granite.client.messaging.transport.TransportMessage;
030    
031    /**
032     * @author Franck WOLFF
033     */
034    public interface Channel {
035            
036        public static final String RECONNECT_INTERVAL_MS_KEY = "reconnect-interval-ms";
037        public static final String RECONNECT_MAX_ATTEMPTS_KEY = "reconnect-max-attempts";
038        
039        public static final String BYTEARRAY_BODY_HEADER = "GDS_BYTEARRAY_BODY";    
040    
041            Transport getTransport();
042            String getId();
043            URI getUri();
044            String getClientId();
045            
046            boolean start();
047            boolean isStarted();
048            boolean stop();
049            
050            void setCredentials(Credentials credentials);
051            Credentials getCredentials();
052            boolean isAuthenticated();
053            
054            ResponseMessageFuture send(RequestMessage request, ResponseListener... listeners);
055            ResponseMessageFuture logout(ResponseListener... listeners);
056            
057            <D> D getTransportData();
058            void setTransportData(Object data);
059    
060            void onMessage(InputStream is);
061            void onError(TransportMessage message, Exception e);
062            void onCancelled(TransportMessage message);
063    }