Class PlannedShutdownSignalImpl

  • All Implemented Interfaces:
    com.sun.enterprise.ee.cms.core.AliveAndReadySignal, com.sun.enterprise.ee.cms.core.PlannedShutdownSignal, com.sun.enterprise.ee.cms.core.Signal

    public class PlannedShutdownSignalImpl
    extends java.lang.Object
    implements com.sun.enterprise.ee.cms.core.PlannedShutdownSignal
    Implementation of PlannedShutdownSignal.
    Version:
    $Revision$
    Author:
    Shreedhar Ganapathy Date: Feb 22, 2005
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static java.util.logging.Logger logger  
    • Constructor Summary

      Constructors 
      Constructor Description
      PlannedShutdownSignalImpl​(java.lang.String memberToken, java.lang.String groupName, long startTime, com.sun.enterprise.ee.cms.core.GMSConstants.shutdownType shutdownType)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void acquire()
      Signal is acquired prior to processing of the signal to protect group resources being acquired from being affected by a race condition
      com.sun.enterprise.ee.cms.core.AliveAndReadyView getCurrentView()  
      com.sun.enterprise.ee.cms.core.GMSConstants.shutdownType getEventSubType()
      Planned shutdown events can be one of two types, Group Shutdown or Instance Shutdown.
      java.lang.String getGroupName()
      returns the group to which the member involved in the Signal belonged to
      java.util.Map<java.io.Serializable,​java.io.Serializable> getMemberDetails()
      returns the details of the member who caused this Signal to be generated returns a Map containing key-value pairs constituting data pertaining to the member's details
      java.lang.String getMemberToken()  
      com.sun.enterprise.ee.cms.core.AliveAndReadyView getPreviousView()  
      long getStartTime()  
      void release()
      Signal is released after processing of the signal to bring the group resources to a state of availability
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • logger

        protected static final java.util.logging.Logger logger
    • Constructor Detail

      • PlannedShutdownSignalImpl

        public PlannedShutdownSignalImpl​(java.lang.String memberToken,
                                         java.lang.String groupName,
                                         long startTime,
                                         com.sun.enterprise.ee.cms.core.GMSConstants.shutdownType shutdownType)
    • Method Detail

      • acquire

        public void acquire()
                     throws com.sun.enterprise.ee.cms.core.SignalAcquireException
        Signal is acquired prior to processing of the signal to protect group resources being acquired from being affected by a race condition
        Specified by:
        acquire in interface com.sun.enterprise.ee.cms.core.Signal
        Throws:
        com.sun.enterprise.ee.cms.core.SignalAcquireException - Exception when unable to aquire the signal
      • release

        public void release()
                     throws com.sun.enterprise.ee.cms.core.SignalReleaseException
        Signal is released after processing of the signal to bring the group resources to a state of availability
        Specified by:
        release in interface com.sun.enterprise.ee.cms.core.Signal
        Throws:
        com.sun.enterprise.ee.cms.core.SignalReleaseException - Exception when unable to release the signal
      • getMemberToken

        public java.lang.String getMemberToken()
        Specified by:
        getMemberToken in interface com.sun.enterprise.ee.cms.core.Signal
      • getMemberDetails

        public java.util.Map<java.io.Serializable,​java.io.Serializable> getMemberDetails()
        returns the details of the member who caused this Signal to be generated returns a Map containing key-value pairs constituting data pertaining to the member's details
        Specified by:
        getMemberDetails in interface com.sun.enterprise.ee.cms.core.Signal
        Returns:
        Map - <Serializable, Serializable>
      • getGroupName

        public java.lang.String getGroupName()
        returns the group to which the member involved in the Signal belonged to
        Specified by:
        getGroupName in interface com.sun.enterprise.ee.cms.core.Signal
        Returns:
        String
      • getStartTime

        public long getStartTime()
        Specified by:
        getStartTime in interface com.sun.enterprise.ee.cms.core.Signal
      • getEventSubType

        public com.sun.enterprise.ee.cms.core.GMSConstants.shutdownType getEventSubType()
        Planned shutdown events can be one of two types, Group Shutdown or Instance Shutdown. These types are defined in an enum in the class GMSConstants.shutdownType
        Specified by:
        getEventSubType in interface com.sun.enterprise.ee.cms.core.PlannedShutdownSignal
        Returns:
        GMSConstants.shutdownType
        See Also:
        GMSConstants
      • getCurrentView

        public com.sun.enterprise.ee.cms.core.AliveAndReadyView getCurrentView()
        Specified by:
        getCurrentView in interface com.sun.enterprise.ee.cms.core.AliveAndReadySignal
      • getPreviousView

        public com.sun.enterprise.ee.cms.core.AliveAndReadyView getPreviousView()
        Specified by:
        getPreviousView in interface com.sun.enterprise.ee.cms.core.AliveAndReadySignal