net.sf.eBus.client.sysmessages.LogonCompleteMessage Maven / Gradle / Ivy

Go to download
//
// This library 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.
//
// This library 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.,
// 59 Temple Place, Suite 330,
// Boston, MA
// 02111-1307 USA
//
// The Initial Developer of the Original Code is Charles W. Rapp.
// Portions created by Charles W. Rapp are
// Copyright 2014, 2016. Charles W. Rapp
// All Rights Reserved.
//

package net.sf.eBus.client.sysmessages;

import java.io.Serializable;
import net.sf.eBus.messages.EFieldInfo;
import net.sf.eBus.messages.ESystemMessage;

/**
 * This message is sent by both
 * {@link net.sf.eBus.client.ERemoteApp} peers to signal that
 * all initial advertisements are sent, completing the logon
 * process. When received, the
 * {@link net.sf.eBus.client.ConnectionMessage eBus connection}
 * subscribers are informed that this eBus is now successfully
 * logged on to the remote eBus application.
 * 
 * This message has no fields of its own.
 *
 * @see LogonMessage
 * @see LogonReply
 * @see AbstractLogonMessage
 *
 * @author Charles Rapp
 */

@EFieldInfo(fields={})
public final class LogonCompleteMessage
    extends AbstractLogonMessage
    implements Serializable
{
//---------------------------------------------------------------
// Member methods.
//

    //-----------------------------------------------------------
    // Constructors.
    //

    /**
     * Creates a new LogonCompleteMessage instance for the given
     * eBus identifier. The subject and timestamp are set to the
     * {@link ESystemMessage} defaults.
     * @param eid the eBus identifier.
     * @throws IllegalArgumentException
     * if {@code eid} is either {@code null} or empty.
     */
    public LogonCompleteMessage(final String eid)
        throws IllegalArgumentException
    {
        super (eid);
    } // end of LogonCompleteMessage(String)

    /**
     * Creates a new logon complete message from the
     * de-serialized values.
     * @param subject
     * {@link net.sf.eBus.messages.ESystemMessage#SYSTEM_SUBJECT}.
     * @param timestamp the message millisecond timestamp.
     * @param eid the eBus identifier.
     * @throws IllegalArgumentException
     * if {@code subject} or {@code eid} is {@code null} or
     * empty.
     */
    public LogonCompleteMessage(final String subject,
                                final long timestamp,
                                final String eid)
        throws IllegalArgumentException
    {
        super (subject, timestamp, eid);
    } // end of LogonCompleteMessage(String, long, String)

    //
    // end of Constructors.
    //-----------------------------------------------------------

//---------------------------------------------------------------
// Member data.
//

    //-----------------------------------------------------------
    // Constants.
    //

    /**
     * Serialization version identifier.
     */
    private static final long serialVersionUID = 0x060100L;
} // end of class LogonCompleteMessage