Package com.ibm.di.fc.itregistry

Class ITRegistryBook

  • public class ITRegistryBook
extends java.lang.Object
    This book is statically shared between the IT registry Components.

    • Constructor Summary

      Constructors 
      Constructor Description
      ITRegistryBook​(java.lang.String bookName)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Closes this IT registry book.
      java.lang.String getBookName()
      Returns the IT registry book name.
      long getInitTime()
      Returns the timestamp of the moment when the MSS associated with this book was registered.
      boolean isOpened()
      Checks if this book is already opened.
      boolean isRefresh()
      Whether this is a refresh book.
      boolean isRemovedStale()
      Check if one of the Components working with this book has already cleared the IT registry from older artifacts.
      void open​(boolean refresh, long inittime)
      Opens the IT registry book.
      void setRemovedStale​(boolean removedStale)
      Sets whether one of the Components working with this book has already cleared the IT registry from older artifacts.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ITRegistryBook

        public ITRegistryBook​(java.lang.String bookName)
        Constructor.
        Parameters:
        bookName - name of the book.

    • Method Detail

      • isRefresh

        public boolean isRefresh()
        Whether this is a refresh book. Refresh causes all stale managed elements to be removed form the IT registry.
        Returns:
        true if it is a refresh book, otherwise false.

      • getBookName

        public java.lang.String getBookName()
        Returns the IT registry book name.
        Returns:
        the book name.

      • getInitTime

        public long getInitTime()
        Returns the timestamp of the moment when the MSS associated with this book was registered.
        Returns:
        a time stamp (in milliseconds since January 1, 1970, 00:00:00 GMT).

      • isOpened

        public boolean isOpened()
        Checks if this book is already opened. A book must be opened in order to add information to it.
        Returns:
        true if this book is already opened, otherwise false.

      • close

        public void close()
           throws java.lang.Exception
        Closes this IT registry book.
        Throws:
        java.lang.Exception - if a problem occurs.

      • open

        public void open​(boolean refresh,
                 long inittime)
          throws java.lang.Exception
        Opens the IT registry book.
        Parameters:
        refresh - whether to perform a refresh operation to the artifacts added.
        inittime - the time when MSS has successfully got registered (in milliseconds).
        Throws:
        java.lang.Exception - if a problem occurs.

      • isRemovedStale

        public boolean isRemovedStale()
        Check if one of the Components working with this book has already cleared the IT registry from older artifacts.
        Returns:
        true if a removeStale() operation has been performed, false otherwise.

      • setRemovedStale

        public void setRemovedStale​(boolean removedStale)
        Sets whether one of the Components working with this book has already cleared the IT registry from older artifacts.
        Parameters:
        removedStale - either true or false.