net.sf.eBus.client.sysmessages.LogonCompleteMessage Maven / Gradle / Ivy
//
// Copyright 2014, 2016, 2019 Charles W. Rapp
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
package net.sf.eBus.client.sysmessages;
import java.io.Serializable;
/**
* This message is sent by both {@code 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
*/
public final class LogonCompleteMessage
extends AbstractLogonMessage
implements Serializable
{
//---------------------------------------------------------------
// Member data.
//
//-----------------------------------------------------------
// Constants.
//
/**
* Serialization version identifier.
*/
private static final long serialVersionUID = 0x050200L;
//---------------------------------------------------------------
// Member methods.
//
//-----------------------------------------------------------
// Constructors.
//
/**
* Creates a new LogonCompleteMessage instance from the given
* message builder.
* @param builder message builder.
*/
private LogonCompleteMessage(final Builder builder)
{
super (builder);
} // end of LogonCompleteMessage(Builder)
//
// end of Constructors.
//-----------------------------------------------------------
/**
* Returns a new instance of the {@code LogonCompleteMessage}
* builder.
* @return message builder instance.
*/
public static Builder builder()
{
return (new Builder());
} // end of builder()
//---------------------------------------------------------------
// Inner classes.
//
/**
* Class used to create {@link LogonCompleteMessage}
* instances. Used by eBus to de-serialize an encoded
* message.
*/
public static final class Builder
extends AbstractLogonMessage.Builder
{
//-----------------------------------------------------------
// Member data.
//
//-----------------------------------------------------------
// Member methods.
//
//-------------------------------------------------------
// Constructors.
//
private Builder()
{
super (LogonCompleteMessage.class);
} // end of Builder()
//
// end of Constructors.
//-------------------------------------------------------
//-------------------------------------------------------
// Builder Method Overrides.
//
/**
* Returns the newly instantiated
* {@code LogonCompleteMessage} based on this builder
* configuration.
* @return target message instance.
*/
@Override
protected LogonCompleteMessage buildImpl()
{
return (new LogonCompleteMessage(this));
} // end of buildImpl()
//
// end of Builder Method Overrides.
//-------------------------------------------------------
} // end of class Builder
} // end of class LogonCompleteMessage