Interface Jaguar::FileViewer

An interface for accessing remote log files. The interface is implemented by a built-in server-side C++ statefull component.

Operation Index

• customLogFileLocationIds
• destroy
• getPosition
• initialize
• logFileIds
• logFileIdsByLocation
• logFileLocationIds
• logFileLocationName
• logName
• setExtensions
• setPosition
• size
• text

Operations

• customLogFileLocationIds

  Returns a sequence of logFileIds corresponding to each directory location passed to the function.

      Jaguar::LogFileId customLogFileLocationIds
      (
          in Jaguar::List directories,
          in long numdirectories,
          in long lastIndex
      );
  

• destroy

  Since the FileViewer is a statefull component, the destroy method calls JagCompleteWork to free up the instance.

      void destroy
      (
      );
  

• getPosition

  Returns the position in the log file given the log file id, the current reference position, and the offset w.r.to the current reference position.

      long getPosition
      (
          in long theLogFileId,
          in long refPosition,
          in long offset
      );
  

• initialize

  Initialize the server-side File Viewer component.

      long initialize
      (
          in string serverName
      );
  

• logFileIds

  Returns a sequence of logFileIds corresponding to each server side log file.

      Jaguar::LogFileId logFileIds
      (
      );
  

• logFileIdsByLocation

  Returns a sequence of logFileIds corresponding to each server side log file in the specified location.

      Jaguar::LogFileId logFileIdsByLocation
      (
          in long locationId
      );
  

• logFileLocationIds

  Returns a sequence of logFileIds corresponding to each server side log location.

      Jaguar::LogFileId logFileLocationIds
      (
      );
  

• logFileLocationName

  Returns the name of the specified server side log location.

      string logFileLocationName
      (
          in long locationId
      );
  

• logName

  Returns the log file name given the log file id.

      string logName
      (
          in long theLogFileId
      );
  

• setExtensions

      void setExtensions
      (
          in Jaguar::List extensions,
          in long numExtensions
      );
  

• setPosition

  Sets & returns the position in the log file given the log file id, the current reference position, and the offset w.r.to the current reference position.

      long setPosition
      (
          in long theLogFileId,
          in long refPosition,
          in long offset
      );
  

• size

  Returns the size of the log file given the log file id.

      long size
      (
          in long theLogFileId
      );
  

• text

  Returns the text string in the log file given the log file id. The text starting from the current reference position till the offset is returned.

      string text
      (
          in long theLogFileId,
          in long refPosition,
          in long offset
      );