package org.astrogrid.samp.gui; import java.awt.Color; import java.awt.Component; import java.awt.Graphics; import java.util.ArrayList; import java.util.Iterator; import java.util.List; import java.util.logging.Level; import java.util.logging.Logger; import javax.swing.Icon; import javax.swing.SwingUtilities; import javax.swing.event.ChangeEvent; import javax.swing.event.ChangeListener; import org.astrogrid.samp.Client; import org.astrogrid.samp.Message; import org.astrogrid.samp.Response; /** * Describes the properties of a message which has been sent from one * client to another. Methods which might change the state of instances * of this class should be invoked only from the AWT event dispatch thread. * * @author Mark Taylor * @since 20 Nov 2008 */ public class Transmission { private final Client sender_; private final Client receiver_; private final Message msg_; private final String msgId_; private final String msgTag_; private final List listenerList_; private final ChangeEvent evt_; private Response response_; private Throwable error_; private boolean senderUnreg_; private boolean receiverUnreg_; private long doneTime_; private static final Logger logger_ = Logger.getLogger( Transmission.class.getName() ); /** * Constructor. * * @param sender sender * @param receiver receiver * @param msg message * @param msgTag message tag * @param msgId message ID */ public Transmission( Client sender, Client receiver, Message msg, String msgTag, String msgId ) { sender_ = sender; receiver_ = receiver; msg_ = msg; msgTag_ = msgTag; msgId_ = msgId; listenerList_ = new ArrayList(); evt_ = new ChangeEvent( this ); doneTime_ = Long.MAX_VALUE; } /** * Returns the client which sent this transmission. * * @return sender */ public Client getSender() { return sender_; } /** * Returns the client to which this transmission was sent. * * @return receiver */ public Client getReceiver() { return receiver_; } /** * Returns the message which was sent. * * @return message */ public Message getMessage() { return msg_; } /** * Returns the message tag corresponding to this transmission. * Will be null for notify-type sends. * * @return msg tag */ public String getMessageTag() { return msgTag_; } /** * Returns the message ID associated with this message. * This is the identifier passed to the receiver which it uses to * match messages with responses; it will be null iff the transmission * used the notify delivery pattern (no response expected). * * @return msgId; possibly null */ public String getMessageId() { return msgId_; } /** * Sets the response for this transmission. * * @param response response */ public void setResponse( Response response ) { response_ = response; fireChange(); } /** * Returns the response for this transmission. * Will be null if no response has (yet) arrived. * * @return response */ public Response getResponse() { return response_; } /** * Associates an error with this transmission. * This is probably an indication that the send failed or some other * non-SAMP event intervened to prevent normal resolution. * * @param error throwable causing the failure */ public void setError( Throwable error ) { error_ = error; logger_.log( Level.WARNING, "Error in hub operation: " + error.getMessage(), error ); fireChange(); } /** * Returns a Throwable which prevented normal resolution of this * transmission. * * @return error */ public Throwable getError() { return error_; } /** * Indicates that the sender of this transmission has unregistered. */ public void setSenderUnregistered() { senderUnreg_ = true; fireChange(); } /** * Indicates that the receiver of this transmission has unregistered. */ public void setReceiverUnregistered() { receiverUnreg_ = true; fireChange(); } /** * Returns the epoch at which this transmission was completed. * If it is still pending ({@link #isDone()}==false), * the returned value will be (way) in the future. * * @return value of System.currentTimeMillis() at which * {@link #isDone} first returned true */ public long getDoneTime() { return doneTime_; } /** * Indicates whether further changes to the state of this object * are expected, that is if a response/failure is yet to be received. * * @return true iff no further changes are expected */ public boolean isDone() { return error_ != null || response_ != null || ( msgId_ == null && msgTag_ == null ) || receiverUnreg_; } /** * Returns an object which describes the current status of this * transmission in terms which can be presented to the GUI. */ public Status getStatus() { if ( error_ != null ) { return Status.EXCEPTION; } else if ( response_ != null ) { String status = response_.getStatus(); if ( Response.OK_STATUS.equals( status ) ) { return Status.OK; } else if ( Response.WARNING_STATUS.equals( status ) ) { return Status.WARNING; } else if ( Response.ERROR_STATUS.equals( status ) ) { return Status.ERROR; } else if ( status == null ) { return Status.NONE; } else { return new Status( "Completed (" + status + ")", Status.WARNING_COLOR, true ); } } else if ( msgId_ == null && msgTag_ == null ) { return Status.NOTIFIED; } else if ( receiverUnreg_ ) { return Status.ORPHANED; } else { assert ! isDone(); return Status.PENDING; } } /** * Adds a listener which will be notified if the state of this transmission * changes (if a response or failure is signalled). * The {@link javax.swing.event.ChangeEvent}s sent to these listeners * will have a source which is this Transmission. * * @param listener listener to add */ public void addChangeListener( ChangeListener listener ) { listenerList_.add( listener ); } /** * Removes a listener previously added by {@link #addChangeListener}. * * @param listener listener to remove */ public void removeChangeListener( ChangeListener listener ) { listenerList_.remove( listener ); } /** * Notifies listeners of a state change. */ private void fireChange() { if ( doneTime_ == Long.MAX_VALUE && isDone() ) { doneTime_ = System.currentTimeMillis(); } for ( Iterator it = listenerList_.iterator(); it.hasNext(); ) { ChangeListener listener = (ChangeListener) it.next(); listener.stateChanged( evt_ ); } } /** * Describes the status of a transmission in terms that can be * presented in the GUI. */ public static class Status { private final String text_; private final Color iconColor_; private final boolean isDone_; private final static Color PENDING_COLOR = Color.BLACK; private final static Color OK_COLOR = new Color( 0x00c000 ); private final static Color ERROR_COLOR = new Color( 0xc00000 ); private final static Color WARNING_COLOR = new Color( 0x806030 ); private final static Color NOTIFY_COLOR = new Color( 0x808080 ); private final static Status OK = new Status( "Success", OK_COLOR, true ); private final static Status WARNING = new Status( "Warning", WARNING_COLOR, true ); private final static Status ERROR = new Status( "Error", ERROR_COLOR, true ); private final static Status NONE = new Status( "Completed (??)", WARNING_COLOR, true ); private final static Status NOTIFIED = new Status( "Notified", NOTIFY_COLOR, true ); private final static Status EXCEPTION = new Status( "Exception", ERROR_COLOR, true ); private final static Status ORPHANED = new Status( "Orphaned", WARNING_COLOR, true ); private final static Status PENDING = new Status( "...pending...", PENDING_COLOR, false ); /** * Constructor. * * @param text short status summary * @param iconColor colour to plot icon * @param isDone whether status represents completed processing */ Status( String text, Color iconColor, boolean isDone ) { text_ = text; iconColor_ = iconColor; isDone_ = isDone; } /** * Returns the text for this status. * * @return short summmary */ public String getText() { return text_; } /** * Returns a little icon representing status. * * @param height required height of icon * @return icon */ public Icon getIcon( final int height ) { final int width = (int) Math.floor( 0.866 * height ); return new Icon() { public void paintIcon( Component c, Graphics g, int x, int y ) { int[] xs = new int[] { x, x + width, x, }; int[] ys = new int[] { y, y + height / 2, y + height, }; Color gcolor = g.getColor(); g.setColor( iconColor_ ); if ( isDone_ ) { g.drawPolygon( xs, ys, 3 ); } else { g.fillPolygon( xs, ys, 3 ); } g.setColor( gcolor ); } public int getIconWidth() { return width; } public int getIconHeight() { return height; } }; } public String toString() { return text_; } } }