com.ibm.websphere.logging.hpel.reader

Class AbstractRemoteRepositoryReader

  1. java.lang.Object
  2. extended bycom.ibm.websphere.logging.hpel.reader.AbstractRemoteRepositoryReader
All implemented interfaces:
RepositoryReader

  1. public abstract class AbstractRemoteRepositoryReader
  2. extends java.lang.Object
  3. implements RepositoryReader
Abstract implementation of the RepositoryReader for remote reading of log records. Extensions of this class need need to provide transportation of parameters and results over the wire. On the server side of the call readLogLists(LogQueryBean, RepositoryPointer) should result in RemoteResultCollector.getLogLists(LogQueryBean, RepositoryPointer) to be called and readLogRecords(RemoteInstanceDetails, RepositoryPointer, int, int, Locale) - in RemoteResultCollector.getLogListForServerInstance(RemoteInstanceDetails, RepositoryPointer, int, int, Locale).

Constructor Summary

Modifier Constructor and Description
  1. protected
AbstractRemoteRepositoryReader(int maxRecords,java.util.Locale locale)
constructs instance returning log records translated into specified Locale and with a limit on number of records requested in each call to server.
  1. protected
AbstractRemoteRepositoryReader(java.util.Locale locale)
constructs instance returning log records translated into specified Locale.

Method Summary

Modifier and Type Method and Description
  1. ServerInstanceLogRecordList
getLogListForCurrentServerInstance()
  1. ServerInstanceLogRecordList
getLogListForServerInstance(java.util.Date time)
  1. ServerInstanceLogRecordList
getLogListForServerInstance(java.util.Date time,int threadID)
  1. ServerInstanceLogRecordList
getLogListForServerInstance(java.util.Date time,java.util.logging.Level minLevel,java.util.logging.Level maxLevel)
  1. ServerInstanceLogRecordList
getLogListForServerInstance(java.util.Date time,LogQueryBean query)
returns log records from the repository of a server instance running at a specified time, according to the criteria specified by the log query bean.
  1. ServerInstanceLogRecordList
getLogListForServerInstance(RepositoryPointer after)
  1. ServerInstanceLogRecordList
getLogListForServerInstance(RepositoryPointer after,int threadID)
  1. ServerInstanceLogRecordList
getLogListForServerInstance(RepositoryPointer after,java.util.logging.Level minLevel,java.util.logging.Level maxLevel)
  1. ServerInstanceLogRecordList
getLogListForServerInstance(RepositoryPointer after,LogQueryBean query)
returns log records from the repository for one server instance that are beyond a given repository location, according to the criteria specified by the log query bean.
  1. java.lang.Iterable<ServerInstanceLogRecordList>
getLogLists()
  1. java.lang.Iterable<ServerInstanceLogRecordList>
getLogLists(java.util.Date minTime,java.util.Date maxTime)
  1. java.lang.Iterable<ServerInstanceLogRecordList>
getLogLists(java.util.logging.Level minLevel,java.util.logging.Level maxLevel)
  1. java.lang.Iterable<ServerInstanceLogRecordList>
getLogLists(LogQueryBean query)
returns log records from the repository according to the criteria specified by the log query bean.
  1. java.lang.Iterable<ServerInstanceLogRecordList>
getLogLists(RepositoryPointer after)
  1. java.lang.Iterable<ServerInstanceLogRecordList>
getLogLists(RepositoryPointer after,java.util.Date maxTime)
  1. java.lang.Iterable<ServerInstanceLogRecordList>
getLogLists(RepositoryPointer after,java.util.logging.Level minLevel,java.util.logging.Level maxLevel)
  1. java.lang.Iterable<ServerInstanceLogRecordList>
getLogLists(RepositoryPointer after,LogQueryBean query)
returns log records from the repository that are beyond a given repository location, according to the criteria specified by the log query bean.
  1. int
getMaxRecords()
Returns limit on records set for this instance.
  1. abstract
  2. RemoteAllResults
readLogLists(LogQueryBean query,RepositoryPointer after)
retrieves results for all server instances in the repository.
  1. abstract
  2. RemoteInstanceResult
readLogRecords(RemoteInstanceDetails indicator,RepositoryPointer after,int offset,int size,java.util.Locale locale)
retrieves records and header for one server instance.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractRemoteRepositoryReader

  1. protected AbstractRemoteRepositoryReader( java.util.Locale locale)
constructs instance returning log records translated into specified Locale.
Parameters:
locale - language all records should be translated to. null means not translation required.

AbstractRemoteRepositoryReader

  1. protected AbstractRemoteRepositoryReader( int maxRecords,
  2. java.util.Locale locale)
constructs instance returning log records translated into specified Locale and with a limit on number of records requested in each call to server.
Parameters:
maxRecords - limit on number of records in each request
locale - language all records should be translated to. null means not translation required.

Method Detail

getMaxRecords

  1. public int getMaxRecords()
Returns limit on records set for this instance.
Returns:
maxRecords value

getLogListForCurrentServerInstance

  1. public ServerInstanceLogRecordList getLogListForCurrentServerInstance( )
  2. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns log records from the repository that were created since the last server startup.
Specified by:
Returns:
the iterable list of log records If no records meet the criteria, an Iterable is returned with no entries
Throws:
LogRepositoryException - indicating that an error occurred while reading records from the server.

getLogListForServerInstance

  1. public ServerInstanceLogRecordList getLogListForServerInstance( java.util.Date time)
  2. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns log records from the repository of a server instance running at the time specified.
Specified by:
Parameters:
time - Date value used to determine the server instance where the server start time occurs before this value and the server stop time occurs after this value
Returns:
the iterable list of log records If no records meet the criteria, a list is returned with a null properties object and a null record list
Throws:
LogRepositoryException - indicating that an error occurred while reading records from the server.

getLogListForServerInstance

  1. public ServerInstanceLogRecordList getLogListForServerInstance( RepositoryPointer after)
  2. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns log records from the repository that are beyond a given repository location as specified. Callers need to invoke RepositoryLogRecordHeader.getRepositoryPointer() to obtain the RepositoryPointer for a particular log record. The returned logs will be from one server instance.
Specified by:
Parameters:
after - pointer to a record the list will start after
Returns:
the iterable list of log records If no records meet the criteria, the list is empty.
Throws:
LogRepositoryException - indicating that an error occurred while reading records from the server.

getLogListForServerInstance

  1. public ServerInstanceLogRecordList getLogListForServerInstance( java.util.Date time,
  2. java.util.logging.Level minLevel,
  3. java.util.logging.Level maxLevel)
  4. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns log records from the repository of a server instance running at a specified time, within the level range as specified.
Specified by:
Parameters:
time - Date value used to determine the server instance where the server start time occurs before this value and the server stop time occurs after this value
minLevel - minimum Level that will be included in the returned list
maxLevel - maximum Level that will be included in the returned list
Returns:
the iterable list of log records If no records meet the criteria, the list is empty.
Throws:
LogRepositoryException - indicating that an error occurred while reading records from the server.

getLogListForServerInstance

  1. public ServerInstanceLogRecordList getLogListForServerInstance( RepositoryPointer after,
  2. java.util.logging.Level minLevel,
  3. java.util.logging.Level maxLevel)
  4. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns log records from the repository that are beyond a given repository location and within the level range as specified. Callers need to invoke RepositoryLogRecordHeader.getRepositoryPointer() to obtain the RepositoryPointer for a particular log record. The returned logs will be from one server instance.
Specified by:
Parameters:
after - pointer to a record the list will start after
minLevel - minimum Level that will be included in the returned list
maxLevel - maximum Level that will be included in the returned list
Returns:
the iterable list of log records If no records meet the criteria, the list is empty.
Throws:
LogRepositoryException - indicating that an error occurred while reading records from the server.

getLogListForServerInstance

  1. public ServerInstanceLogRecordList getLogListForServerInstance( java.util.Date time,
  2. int threadID)
  3. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns log records from the repository of a server instance running at a specified time created by the given thread.
Specified by:
Parameters:
time - Date value used to determine the server instance where the server start time occurs before this value and the server stop time occurs after this value
threadID - ID of the thread that the returned records will match
Returns:
the iterable list of log records If no records meet the criteria, the list is empty.
Throws:
LogRepositoryException - indicating that an error occurred while reading records from the server.

getLogListForServerInstance

  1. public ServerInstanceLogRecordList getLogListForServerInstance( RepositoryPointer after,
  2. int threadID)
  3. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns log records from the repository that are beyond a given repository location and created by a given thread as specified. Callers need to invoke RepositoryLogRecordHeader.getRepositoryPointer() to obtain the RepositoryPointer for a particular log record. The returned logs will be from one server instance.
Specified by:
Parameters:
after - pointer to a record the list will start after
threadID - ID of the thread that the returned records will match
Returns:
the iterable list of log records If no records meet the criteria, the list is empty.
Throws:
LogRepositoryException - indicating that an error occurred while reading records from the server.

getLogListForServerInstance

  1. public ServerInstanceLogRecordList getLogListForServerInstance( java.util.Date time,
  2. LogQueryBean query)
  3. throws LogRepositoryException
returns log records from the repository of a server instance running at a specified time, according to the criteria specified by the log query bean.
Specified by:
Parameters:
time - Date value used to determine the server instance where the server start time occurs before this value and the server stop time occurs after this value
query - LogQueryBean instance representing set of criteria each of which need to be met by the return records.
Returns:
the iterable list of log records If no records meet the criteria, the list is empty.
Throws:
LogRepositoryException - indicating that an error occurred while reading records from the server.
See Also:

getLogListForServerInstance

  1. public ServerInstanceLogRecordList getLogListForServerInstance( RepositoryPointer after,
  2. LogQueryBean query)
  3. throws LogRepositoryException
returns log records from the repository for one server instance that are beyond a given repository location, according to the criteria specified by the log query bean.
Specified by:
Parameters:
after - pointer to a record the list will start after
query - LogQueryBean instance representing set of criteria each of which need to be met by the return records.
Returns:
the iterable list of log records If no records meet the criteria, the list is empty.
Throws:
LogRepositoryException - indicating that an error occurred while reading records from the server.
See Also:

getLogLists

  1. public java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( LogQueryBean query)
  2. throws LogRepositoryException
returns log records from the repository according to the criteria specified by the log query bean.
Specified by:
Parameters:
query - LogQueryBean instance representing set of criteria each of which need to be met by the return records.
Returns:
the iterable instance of a list of log records within a process that are within the parameter range If no records meet the criteria, an Iterable is returned with no entries
Throws:
LogRepositoryException - indicating that an error occurred while reading list of instances from the server.

getLogLists

  1. public java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( RepositoryPointer after,
  2. LogQueryBean query)
  3. throws LogRepositoryException
returns log records from the repository that are beyond a given repository location, according to the criteria specified by the log query bean.
Specified by:
Parameters:
after - pointer to a record the list will start after
query - LogQueryBean instance representing set of criteria each of which need to be met by the return records.
Returns:
the iterable instance of a list of log records within a process that are within the parameter range If no records meet the criteria, an Iterable is returned with no entries
Throws:
LogRepositoryException - indicating that an error occurred while reading list of instances from the server.

getLogLists

  1. public java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( )
  2. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns all log records from the repository.
Specified by:
Returns:
the iterable instance of a list of log records within a process
Throws:
LogRepositoryException - indicating that an error occurred while reading list of instances from the server.

getLogLists

  1. public java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( RepositoryPointer after)
  2. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns all log records from the repository beyond a given repository location as specified. Callers need to invoke RepositoryLogRecordHeader.getRepositoryPointer() to obtain the RepositoryPointer for a particular log record.
Specified by:
Parameters:
after - pointer to a record the list will start after
Returns:
the iterable instance of a list of log records within a process. If no records meet the criteria, an Iterable is returned with no entries
Throws:
LogRepositoryException - indicating that an error occurred while reading list of instances from the server.

getLogLists

  1. public java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( java.util.logging.Level minLevel,
  2. java.util.logging.Level maxLevel)
  3. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns log records from the repository that are within the level range as specified.
Specified by:
Parameters:
minLevel - minimum Level that will be included in the returned list
maxLevel - maximum Level that will be included in the returned list
Returns:
the iterable instance of a list of records within a process that are within the parameter range If no records meet the criteria, an Iterable is returned with no entries
Throws:
LogRepositoryException - indicating that an error occurred while reading list of instances from the server.

getLogLists

  1. public java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( RepositoryPointer after,
  2. java.util.logging.Level minLevel,
  3. java.util.logging.Level maxLevel)
  4. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns log records from the repository that are beyond a given repository location and within the level range as specified. Callers need to invoke RepositoryLogRecordHeader.getRepositoryPointer() to obtain the RepositoryPointer for a particular log record.
Specified by:
Parameters:
after - pointer to a record the list will start after
minLevel - minimum Level that will be included in the returned list
maxLevel - maximum Level that will be included in the returned list
Returns:
the iterable instance of a list of log records within a process that are within the parameter range If no records meet the criteria, an Iterable is returned with no entries
Throws:
LogRepositoryException - indicating that an error occurred while reading list of instances from the server.

getLogLists

  1. public java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( java.util.Date minTime,
  2. java.util.Date maxTime)
  3. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns log records from the repository that are within the date range as specified. The parameters can be null to indicate an open ended range. For example, a caller may pass null as the maxTime to indicate that the returned log records do not have to meet a maxTime criteria.
Specified by:
Parameters:
minTime - minimum Date value that will be included in the returned list
maxTime - maximum Date value that will be included in the returned list
Returns:
the iterable instance of a list of log records within a process that are within the parameter range If no records meet the criteria, an Iterable is returned with no entries
Throws:
LogRepositoryException - indicating that an error occurred while reading list of instances from the server.

getLogLists

  1. public java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( RepositoryPointer after,
  2. java.util.Date maxTime)
  3. throws LogRepositoryException
Description copied from interface: RepositoryReader
returns log records from the repository that are beyond a given repository location and occurred before a given time as specified. Callers need to invoke RepositoryLogRecordHeader.getRepositoryPointer() to obtain the RepositoryPointer for a particular log record.
Specified by:
Parameters:
after - pointer to a record the list will start after
maxTime - maximum Date value that will be included in the returned list
Returns:
the iterable instance of a list of log records within a process that are within the parameter range If no records meet the criteria, an Iterable is returned with no entries
Throws:
LogRepositoryException - indicating that an error occurred while reading list of instances from the server.

readLogLists

  1. public abstract RemoteAllResults readLogLists( LogQueryBean query,
  2. RepositoryPointer after)
  3. throws LogRepositoryException
retrieves results for all server instances in the repository. Implementation should usually result in RemoteResultCollector.getLogLists(LogQueryBean, RepositoryPointer) to be invoked with the same parameters on the server side.
Parameters:
query - log query bean indicator
after - reference point after which we need log records.
Returns:
Set of all server instances satisfying the query request.
Throws:
LogRepositoryException - indicating that an error occurred while reading list of instances from the server.

readLogRecords

  1. public abstract RemoteInstanceResult readLogRecords( RemoteInstanceDetails indicator,
  2. RepositoryPointer after,
  3. int offset,
  4. int size,
  5. java.util.Locale locale)
  6. throws LogRepositoryException
retrieves records and header for one server instance. Implementation should usually result in RemoteResultCollector.getLogListForServerInstance(RemoteInstanceDetails, RepositoryPointer, int, int, Locale) to be invoked with the same parameters on the server side.
Parameters:
indicator - server instance identifier.
after - reference point after which we need log records.
offset - number of records to skip after the reference point.
size - maximum number of records to return.
locale - language records should be translated to in the result. null means no translation required.
Returns:
Set of instance log records satisfying the original query request.
Throws:
LogRepositoryException - indicating that an error occurred while reading records from the server.