net.sf.eBusx.monitor.MonitoredObjectRequest 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 2012, 2013, 2016, 2019. Charles W. Rapp
// All Rights Reserved.
//

package net.sf.eBusx.monitor;

import java.io.Serializable;
import net.sf.eBus.messages.EReplyInfo;
import net.sf.eBus.messages.ERequestMessage;

/**
 * Requests the {@link MonitorId}s of those objects within the
 * eBus environment available for monitoring. The request message
 * subject is {@link Monitor#MONITOR_REQUEST}.
 *
 * @author Charles Rapp
 */

@EReplyInfo (replyMessageClasses = {MonitoredObjectReply.class})
public final class MonitoredObjectRequest
    extends ERequestMessage
    implements Serializable
{
//---------------------------------------------------------------
// Member data.
//

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

    /**
     * Serialization version identifier.
     */
    private static final long serialVersionUID = 0x050200L;

//---------------------------------------------------------------
// Member methods.
//

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

    /**
     * Creates a new MonitoredObjectRequest instance.
     */
    @Deprecated
    public MonitoredObjectRequest()
    {
        this (Monitor.MONITOR_REQUEST,
              System.currentTimeMillis());
    } // end of MonitoredObjectRequest()

    /**
     * Deserialize constructor.
     * @param subject the request subject.
     * @param timestamp the message timestamp.
     */
    @Deprecated
    public MonitoredObjectRequest(final String subject,
                                  final long timestamp)
    {
        super (subject, timestamp);
    } // end of MonitoredObjectRequest(String, long)

    /**
     * Creates a new monitor object request generated from the
     * builder settings.
     * @param builder takes setting from this message builder.
     */
    private MonitoredObjectRequest(final Builder builder)
    {
        super (builder);
    } // end of MonitoredObjectRequest(Builder)

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

    public static Builder builder()
    {
        return (new Builder());
    } // end of builder()

//---------------------------------------------------------------
// Inner classes.
//

    public static final class Builder
        extends ERequestMessage.Builder
    {
    //-----------------------------------------------------------
    // Member data.
    //

    //-----------------------------------------------------------
    // Member methods.
    //

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

        private Builder()
        {
            super (MonitoredObjectRequest.class);

            this.subject(Monitor.MONITOR_REQUEST);
        } // end of Builder()

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

        //-------------------------------------------------------
        // Builder Method Overrides.
        //

        @Override
        protected MonitoredObjectRequest buildImpl()
        {
            return (new MonitoredObjectRequest(this));
        } // end of buildImpl()

        //
        // end of Builder Method Overrides.
        //-------------------------------------------------------
    } // end of class Builder
} // end of class MonitoredObjectRequest