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.messages;
022    
023    import java.io.Externalizable;
024    import java.util.Map;
025    
026    /**
027     * @author Franck WOLFF
028     */
029    public interface Message extends Externalizable, Cloneable {
030    
031            public static enum Type {
032                    
033                    // Request types.
034                    PING,
035                    LOGIN,
036                    LOGOUT,
037                    INVOCATION,
038                    SUBSCRIBE,
039                    UNSUBSCRIBE,
040                    PUBLISH,
041                    
042                    // Response types.
043                    RESULT,
044                    FAULT,
045                    
046                    // Push types.
047                    TOPIC,
048                    DISCONNECT
049            }
050        
051        Type getType();
052            
053            String getId();
054        void setId(String id);
055            
056            String getClientId();
057        void setClientId(String clientId);
058    
059            long getTimestamp();
060        void setTimestamp(long timestamp);
061            
062        long getTimeToLive();
063        void setTimeToLive(long timeToLive);
064    
065        Map<String, Object> getHeaders();
066        void setHeaders(Map<String, Object> headers);
067            Object getHeader(String name);
068        void setHeader(String name, Object value);
069            boolean headerExists(String name);
070        
071        boolean isExpired();
072        boolean isExpired(long millis);
073        long getRemainingTimeToLive();
074        long getRemainingTimeToLive(long millis);
075        
076        public Message copy();
077        public Message clone() throws CloneNotSupportedException;
078    }