Class AbstractRemoteRepositoryReader
- java.lang.Object
- 
- com.ibm.websphere.logging.hpel.reader.AbstractRemoteRepositoryReader
 
- 
- All Implemented Interfaces:
- RepositoryReader
 
 public abstract class AbstractRemoteRepositoryReader extends java.lang.Object 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 callreadLogLists(LogQueryBean, RepositoryPointer)should result inRemoteResultCollector.getLogLists(LogQueryBean, RepositoryPointer)to be called andreadLogRecords(RemoteInstanceDetails, RepositoryPointer, int, int, Locale)- inRemoteResultCollector.getLogListForServerInstance(RemoteInstanceDetails, RepositoryPointer, int, int, Locale).
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description ServerInstanceLogRecordListgetLogListForCurrentServerInstance()returns log records from the repository that were created since the last server startup.ServerInstanceLogRecordListgetLogListForServerInstance(RepositoryPointer after)returns log records from the repository that are beyond a given repository location as specified.ServerInstanceLogRecordListgetLogListForServerInstance(RepositoryPointer after, int threadID)returns log records from the repository that are beyond a given repository location and created by a given thread as specified.ServerInstanceLogRecordListgetLogListForServerInstance(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.ServerInstanceLogRecordListgetLogListForServerInstance(RepositoryPointer after, java.util.logging.Level minLevel, java.util.logging.Level maxLevel)returns log records from the repository that are beyond a given repository location and within the level range as specified.ServerInstanceLogRecordListgetLogListForServerInstance(java.util.Date time)returns log records from the repository of a server instance running at the time specified.ServerInstanceLogRecordListgetLogListForServerInstance(java.util.Date time, int threadID)returns log records from the repository of a server instance running at a specified time created by the given thread.ServerInstanceLogRecordListgetLogListForServerInstance(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.ServerInstanceLogRecordListgetLogListForServerInstance(java.util.Date time, java.util.logging.Level minLevel, java.util.logging.Level maxLevel)returns log records from the repository of a server instance running at a specified time, within the level range as specified.java.lang.Iterable<ServerInstanceLogRecordList>getLogLists()returns all log records from the repository.java.lang.Iterable<ServerInstanceLogRecordList>getLogLists(LogQueryBean query)returns log records from the repository according to the criteria specified by the log query bean.java.lang.Iterable<ServerInstanceLogRecordList>getLogLists(RepositoryPointer after)returns all log records from the repository beyond a given repository location as specified.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.java.lang.Iterable<ServerInstanceLogRecordList>getLogLists(RepositoryPointer after, java.util.Date maxTime)returns log records from the repository that are beyond a given repository location and occurred before a given time as specified.java.lang.Iterable<ServerInstanceLogRecordList>getLogLists(RepositoryPointer after, java.util.logging.Level minLevel, java.util.logging.Level maxLevel)returns log records from the repository that are beyond a given repository location and within the level range as specified.java.lang.Iterable<ServerInstanceLogRecordList>getLogLists(java.util.Date minTime, java.util.Date maxTime)returns log records from the repository that are within the date range as specified.java.lang.Iterable<ServerInstanceLogRecordList>getLogLists(java.util.logging.Level minLevel, java.util.logging.Level maxLevel)returns log records from the repository that are within the level range as specified.intgetMaxRecords()Returns limit on records set for this instance.abstract RemoteAllResultsreadLogLists(LogQueryBean query, RepositoryPointer after)retrieves results for all server instances in the repository.abstract RemoteInstanceResultreadLogRecords(RemoteInstanceDetails indicator, RepositoryPointer after, int offset, int size, java.util.Locale locale)retrieves records and header for one server instance.
 
- 
- 
- 
Method Detail- 
getMaxRecordspublic int getMaxRecords() Returns limit on records set for this instance.- Returns:
- maxRecords value
 
 - 
getLogListForCurrentServerInstancepublic ServerInstanceLogRecordList getLogListForCurrentServerInstance() throws LogRepositoryException Description copied from interface:RepositoryReaderreturns log records from the repository that were created since the last server startup.- Specified by:
- getLogListForCurrentServerInstancein interface- RepositoryReader
- 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.
 
 - 
getLogListForServerInstancepublic ServerInstanceLogRecordList getLogListForServerInstance(java.util.Date time) throws LogRepositoryException Description copied from interface:RepositoryReaderreturns log records from the repository of a server instance running at the time specified.- Specified by:
- getLogListForServerInstancein interface- RepositoryReader
- Parameters:
- time-- Datevalue 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.
 
 - 
getLogListForServerInstancepublic ServerInstanceLogRecordList getLogListForServerInstance(RepositoryPointer after) throws LogRepositoryException Description copied from interface:RepositoryReaderreturns log records from the repository that are beyond a given repository location as specified. Callers need to invokeRepositoryLogRecordHeader.getRepositoryPointer()to obtain the RepositoryPointer for a particular log record. The returned logs will be from one server instance.- Specified by:
- getLogListForServerInstancein interface- RepositoryReader
- 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.
 
 - 
getLogListForServerInstancepublic ServerInstanceLogRecordList getLogListForServerInstance(java.util.Date time, java.util.logging.Level minLevel, java.util.logging.Level maxLevel) throws LogRepositoryException Description copied from interface:RepositoryReaderreturns log records from the repository of a server instance running at a specified time, within the level range as specified.- Specified by:
- getLogListForServerInstancein interface- RepositoryReader
- Parameters:
- time-- Datevalue 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- Levelthat will be included in the returned list
- maxLevel- maximum- Levelthat 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.
 
 - 
getLogListForServerInstancepublic ServerInstanceLogRecordList getLogListForServerInstance(RepositoryPointer after, java.util.logging.Level minLevel, java.util.logging.Level maxLevel) throws LogRepositoryException Description copied from interface:RepositoryReaderreturns log records from the repository that are beyond a given repository location and within the level range as specified. Callers need to invokeRepositoryLogRecordHeader.getRepositoryPointer()to obtain the RepositoryPointer for a particular log record. The returned logs will be from one server instance.- Specified by:
- getLogListForServerInstancein interface- RepositoryReader
- Parameters:
- after- pointer to a record the list will start after
- minLevel- minimum- Levelthat will be included in the returned list
- maxLevel- maximum- Levelthat 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.
 
 - 
getLogListForServerInstancepublic ServerInstanceLogRecordList getLogListForServerInstance(java.util.Date time, int threadID) throws LogRepositoryException Description copied from interface:RepositoryReaderreturns log records from the repository of a server instance running at a specified time created by the given thread.- Specified by:
- getLogListForServerInstancein interface- RepositoryReader
- Parameters:
- time-- Datevalue 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.
 
 - 
getLogListForServerInstancepublic ServerInstanceLogRecordList getLogListForServerInstance(RepositoryPointer after, int threadID) throws LogRepositoryException Description copied from interface:RepositoryReaderreturns log records from the repository that are beyond a given repository location and created by a given thread as specified. Callers need to invokeRepositoryLogRecordHeader.getRepositoryPointer()to obtain the RepositoryPointer for a particular log record. The returned logs will be from one server instance.- Specified by:
- getLogListForServerInstancein interface- RepositoryReader
- 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.
 
 - 
getLogListForServerInstancepublic ServerInstanceLogRecordList getLogListForServerInstance(java.util.Date time, LogQueryBean query) 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:
- getLogListForServerInstancein interface- RepositoryReader
- Parameters:
- time-- Datevalue 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-- LogQueryBeaninstance 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:
- LogQueryBean
 
 - 
getLogListForServerInstancepublic ServerInstanceLogRecordList getLogListForServerInstance(RepositoryPointer after, LogQueryBean query) 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:
- getLogListForServerInstancein interface- RepositoryReader
- Parameters:
- after- pointer to a record the list will start after
- query-- LogQueryBeaninstance 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:
- LogQueryBean
 
 - 
getLogListspublic java.lang.Iterable<ServerInstanceLogRecordList> getLogLists(LogQueryBean query) throws LogRepositoryException returns log records from the repository according to the criteria specified by the log query bean.- Specified by:
- getLogListsin interface- RepositoryReader
- Parameters:
- query-- LogQueryBeaninstance 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.
 
 - 
getLogListspublic java.lang.Iterable<ServerInstanceLogRecordList> getLogLists(RepositoryPointer after, LogQueryBean query) 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:
- getLogListsin interface- RepositoryReader
- Parameters:
- after- pointer to a record the list will start after
- query-- LogQueryBeaninstance 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.
 
 - 
getLogListspublic java.lang.Iterable<ServerInstanceLogRecordList> getLogLists() throws LogRepositoryException Description copied from interface:RepositoryReaderreturns all log records from the repository.- Specified by:
- getLogListsin interface- RepositoryReader
- 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.
 
 - 
getLogListspublic java.lang.Iterable<ServerInstanceLogRecordList> getLogLists(RepositoryPointer after) throws LogRepositoryException Description copied from interface:RepositoryReaderreturns all log records from the repository beyond a given repository location as specified. Callers need to invokeRepositoryLogRecordHeader.getRepositoryPointer()to obtain the RepositoryPointer for a particular log record.- Specified by:
- getLogListsin interface- RepositoryReader
- 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.
 
 - 
getLogListspublic java.lang.Iterable<ServerInstanceLogRecordList> getLogLists(java.util.logging.Level minLevel, java.util.logging.Level maxLevel) throws LogRepositoryException Description copied from interface:RepositoryReaderreturns log records from the repository that are within the level range as specified.- Specified by:
- getLogListsin interface- RepositoryReader
- Parameters:
- minLevel- minimum- Levelthat will be included in the returned list
- maxLevel- maximum- Levelthat 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.
 
 - 
getLogListspublic java.lang.Iterable<ServerInstanceLogRecordList> getLogLists(RepositoryPointer after, java.util.logging.Level minLevel, java.util.logging.Level maxLevel) throws LogRepositoryException Description copied from interface:RepositoryReaderreturns log records from the repository that are beyond a given repository location and within the level range as specified. Callers need to invokeRepositoryLogRecordHeader.getRepositoryPointer()to obtain the RepositoryPointer for a particular log record.- Specified by:
- getLogListsin interface- RepositoryReader
- Parameters:
- after- pointer to a record the list will start after
- minLevel- minimum- Levelthat will be included in the returned list
- maxLevel- maximum- Levelthat 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.
 
 - 
getLogListspublic java.lang.Iterable<ServerInstanceLogRecordList> getLogLists(java.util.Date minTime, java.util.Date maxTime) throws LogRepositoryException Description copied from interface:RepositoryReaderreturns 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 passnullas the maxTime to indicate that the returned log records do not have to meet a maxTime criteria.- Specified by:
- getLogListsin interface- RepositoryReader
- Parameters:
- minTime- minimum- Datevalue that will be included in the returned list
- maxTime- maximum- Datevalue 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.
 
 - 
getLogListspublic java.lang.Iterable<ServerInstanceLogRecordList> getLogLists(RepositoryPointer after, java.util.Date maxTime) throws LogRepositoryException Description copied from interface:RepositoryReaderreturns log records from the repository that are beyond a given repository location and occurred before a given time as specified. Callers need to invokeRepositoryLogRecordHeader.getRepositoryPointer()to obtain the RepositoryPointer for a particular log record.- Specified by:
- getLogListsin interface- RepositoryReader
- Parameters:
- after- pointer to a record the list will start after
- maxTime- maximum- Datevalue 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.
 
 - 
readLogListspublic abstract RemoteAllResults readLogLists(LogQueryBean query, RepositoryPointer after) throws LogRepositoryException retrieves results for all server instances in the repository. Implementation should usually result inRemoteResultCollector.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.
 
 - 
readLogRecordspublic abstract RemoteInstanceResult readLogRecords(RemoteInstanceDetails indicator, RepositoryPointer after, int offset, int size, java.util.Locale locale) throws LogRepositoryException retrieves records and header for one server instance. Implementation should usually result inRemoteResultCollector.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.- nullmeans 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.
 
 
- 
 
-