Class MonitorComponent

    • Constructor Detail

      • MonitorComponent

        public MonitorComponent()
        Deprecated.
    • Method Detail

      • getDefaults

        public java.util.Map<java.lang.String,​java.lang.Object> getDefaults​(java.util.Map<java.lang.String,​java.lang.Object> params)
        Deprecated.
        Description copied from interface: Configurable
        Returns default configuration settings for the component as a Map with keys as configuration property IDs and values as the configuration property values. All the default parameters returned from this method are later passed to the setProperties(...) method. Some of them may have changed value if they have been overwritten in the server configuration. The configuration property value can be of any of the basic types: int, long, boolean, String.
        Specified by:
        getDefaults in interface Configurable
        Overrides:
        getDefaults in class BasicComponent
        Parameters:
        params - is a Map with some initial properties set for the starting up server. These parameters can be used as a hints to generate component's default configuration.
        Returns:
        a Map with the component default configuration.
      • getDiscoCategoryType

        public java.lang.String getDiscoCategoryType()
        Deprecated.
        Description copied from class: BasicComponent
        Method returns component category type used for service discovery responses.
        Overrides:
        getDiscoCategoryType in class BasicComponent
        Returns:
        category type of a component
      • getDiscoDescription

        public java.lang.String getDiscoDescription()
        Deprecated.
        Description copied from class: BasicComponent
        Method returns description used for service discovery responses.
        Overrides:
        getDiscoDescription in class BasicComponent
        Returns:
        description of a component
      • getStatistics

        public void getStatistics​(StatisticsList list)
        Deprecated.
        Description copied from class: AbstractMessageReceiver
        Method returns component statistics. Please note, the method can be called every second by the server monitoring system therefore no extensive or lengthy calculations are allowed. If there are some statistics requiring lengthy operations like database access they must have Level.FINEST assigned and must be put inside the level guard to prevent generating them by the system monitor. The system monitor does not collect FINEST statistics.
        Level guard code looks like the example below:
         if (list.checkLevel(Level.FINEST)) {
           // Some CPU intensive calculations or lengthy operations
           list.add(getName(), "Statistic description", stat_value, Level.FINEST);
         }
        
         
        This way you make sure your extensive operation is not executed every second by the monitoring system and does not affect the server performance.
        Specified by:
        getStatistics in interface StatisticsContainerIfc
        Overrides:
        getStatistics in class AbstractMessageReceiver
        Parameters:
        list - is a StatistcsList where all statistics are stored.
      • initBindings

        public void initBindings​(javax.script.Bindings binds)
        Deprecated.
        Description copied from class: BasicComponent
        Initialize a mapping of key/value pairs which can be used in scripts loaded by the server
        Overrides:
        initBindings in class BasicComponent
        Parameters:
        binds - A mapping of key/value pairs, all of whose keys are Strings.
      • processPacket

        public void processPacket​(Packet packet)
        Deprecated.
        Description copied from class: AbstractMessageReceiver
        This is the main Packet processing method. It is called concurrently from many threads so implementing it in thread save manner is essential. The method is called for each packet addressed to the component.
        Please note, the Packet instance may be processed by different parts of the server, different components or plugins at the same time. Therefore this is very important to tread the Packet instance as unmodifiable object.
        Processing in this method is asynchronous, therefore there is no result value. If there are some 'result' packets generated during processing, they should be passed back using addOutPacket(Packet) method.
        Specified by:
        processPacket in class AbstractMessageReceiver
        Parameters:
        packet - is an instance of the Packet class passed for processing.
      • processingInThreads

        public int processingInThreads()
        Deprecated.
        Description copied from class: AbstractMessageReceiver
        Concurrency control method. Returns preferable number of threads set for this component.
        Overrides:
        processingInThreads in class AbstractMessageReceiver
        Returns:
        preferable number of threads set for this component.
      • processingOutThreads

        public int processingOutThreads()
        Deprecated.
        Description copied from class: AbstractMessageReceiver
        Concurrency control method. Returns preferable number of threads set for this component.
        Overrides:
        processingOutThreads in class AbstractMessageReceiver
        Returns:
        preferable number of threads set for this component.