com.ibm.websphere.product.metadata.im

Class IMEvent

  • java.lang.Object
    • com.ibm.websphere.product.metadata.im.IMEvent

  • public class IMEvent
extends java.lang.Object
    This class represents an event (install, uninstall, update, rollback) based on information from history.xml.
    Version:
    8.0

    • Constructor Summary

      Constructors 
      Constructor and Description
      IMEvent(javax.xml.stream.XMLStreamReader ireader)
      IBM WEBSPHERE INTERNAL USE ONLY.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String[] getAparList()
      Return the list of apars associated with this event.
      java.lang.String getEventStartTime()
      Returns the starting time of this event.
      java.lang.String getEventStatus()
      Returns the status of the current event.
      java.lang.String getEventType()
      Returns the type of the current event.
      IMVersion getIMVersion()
      Returns the version in IBM Install Manager format of the offering after this event has occurred.
      java.lang.String getLogFilePath()
      Returns the full path of the log file which logs the current event.
      java.lang.String getOfferingDescription()
      Returns the description of the offering involved in this event.
      java.lang.String getOfferingID()
      Returns the offering ID of the offering involved in this event.
      java.lang.String getPackageFullVersion()
      Returns the full package version of the offering/fix.
      java.lang.String getVisibleFeatureDescriptionByFeatureID(java.lang.String featureID)
      Return the feature description based on feature ID.
      java.util.Vector<java.lang.String> getVisibleFeatureIDList()
      Returns the list of feature IDs for visible features.
      java.util.Vector<java.lang.String> getVisibleFeatureNameList()
      Returns the list of feature names for visible features.
      boolean hasSameFeatures(java.util.Vector<java.lang.String> featureIDList)
      Returns true if the input feature ID list has the same size as the feature ID list of this event and the 2 lists contain the same IDs.
      boolean isEventForIFix()
      Return true if this event is for ifix.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • S_EVENT_TYPE_INSTALL

        public static java.lang.String S_EVENT_TYPE_INSTALL
        IBM WEBSPHERE INTERNAL USE ONLY.

      • S_EVENT_TYPE_UNINSTALL

        public static java.lang.String S_EVENT_TYPE_UNINSTALL
        IBM WEBSPHERE INTERNAL USE ONLY.

      • S_EVENT_TYPE_UPDATE

        public static java.lang.String S_EVENT_TYPE_UPDATE
        IBM WEBSPHERE INTERNAL USE ONLY.

      • S_EVENT_TYPE_ROLLBACK

        public static java.lang.String S_EVENT_TYPE_ROLLBACK
        IBM WEBSPHERE INTERNAL USE ONLY.

      • S_EVENT_TYPE_INSTALL_FEATURE

        public static java.lang.String S_EVENT_TYPE_INSTALL_FEATURE
        IBM WEBSPHERE INTERNAL USE ONLY.

      • S_EVENT_TYPE_UNINSTALL_FEATURE

        public static java.lang.String S_EVENT_TYPE_UNINSTALL_FEATURE
        IBM WEBSPHERE INTERNAL USE ONLY.

      • S_EVENT_TYPE_MODIFY_FEATURE

        public static java.lang.String S_EVENT_TYPE_MODIFY_FEATURE
        IBM WEBSPHERE INTERNAL USE ONLY.

      • S_EVENT_STATUS_SUCCESS

        public static java.lang.String S_EVENT_STATUS_SUCCESS
        IBM WEBSPHERE INTERNAL USE ONLY.

      • S_EVENT_STATUS_FAIL

        public static java.lang.String S_EVENT_STATUS_FAIL
        IBM WEBSPHERE INTERNAL USE ONLY.

      • S_EVENT_STATUS_PARTIALSUCCESS

        public static java.lang.String S_EVENT_STATUS_PARTIALSUCCESS
        IBM WEBSPHERE INTERNAL USE ONLY.

    • Constructor Detail

      • IMEvent

        public IMEvent(javax.xml.stream.XMLStreamReader ireader)
        throws javax.xml.stream.XMLStreamException
        IBM WEBSPHERE INTERNAL USE ONLY. Constructor.
        Throws:
        javax.xml.stream.XMLStreamException

    • Method Detail

      • getAparList

        public java.lang.String[] getAparList()
        Return the list of apars associated with this event.

        Returns:
        The list of apars associated with this event.

      • getLogFilePath

        public java.lang.String getLogFilePath()
        Returns the full path of the log file which logs the current event.

        Returns:
        the full path of the log file which logs the current event.

      • getEventType

        public java.lang.String getEventType()
        Returns the type of the current event. It can be either "install", "uninstall", "update" or "rollback".

        Returns:
        the type of this event

      • getEventStatus

        public java.lang.String getEventStatus()
        Returns the status of the current event. It can be either "SUCCESS", or "FAIL"

        Returns:
        the status of this event.

      • getEventStartTime

        public java.lang.String getEventStartTime()
        Returns the starting time of this event.

        Returns:
        the starting time of this event.

      • getOfferingID

        public java.lang.String getOfferingID()
        Returns the offering ID of the offering involved in this event.

        Returns:
        the offering ID of the offering involved in this event.

      • getIMVersion

        public IMVersion getIMVersion()
        Returns the version in IBM Install Manager format of the offering after this event has occurred.

        Returns:
        the version in IBM Install Manager format of the offering after this event has occurred.

      • getOfferingDescription

        public java.lang.String getOfferingDescription()
        Returns the description of the offering involved in this event.

        Returns:
        the description of the offering involved in this event.

      • getPackageFullVersion

        public java.lang.String getPackageFullVersion()
        Returns the full package version of the offering/fix.

        Returns:
        The full package version of the offering/fix.

      • getVisibleFeatureIDList

        public java.util.Vector<java.lang.String> getVisibleFeatureIDList()
        Returns the list of feature IDs for visible features.

        Returns:
        the list of feature IDs for visible features.

      • getVisibleFeatureNameList

        public java.util.Vector<java.lang.String> getVisibleFeatureNameList()
        Returns the list of feature names for visible features.

        Returns:
        the list of feature names for visible features.

      • getVisibleFeatureDescriptionByFeatureID

        public java.lang.String getVisibleFeatureDescriptionByFeatureID(java.lang.String featureID)
        Return the feature description based on feature ID.

        Parameters:
        featureID - the ID of this feature

        Returns:
        the feature description based on feature ID.

      • hasSameFeatures

        public boolean hasSameFeatures(java.util.Vector<java.lang.String> featureIDList)
        Returns true if the input feature ID list has the same size as the feature ID list of this event and the 2 lists contain the same IDs. Else return false.

        Parameters:
        featureIDList - the feature ID list to be compared.

        Returns:
        true if the input feature ID list has the same size as the feature ID list of this event and the 2 lists contain the same IDs. Else return false.

      • isEventForIFix

        public boolean isEventForIFix()
        Return true if this event is for ifix. Else return false

        Returns:
        true if this event is for ifix. Else return false
IBM WebSphere Application ServerTM
Release 8.5