org.alfresco.jlan.client.admin

Class EventlogPipeFile

java.lang.Object

org.alfresco.jlan.client.admin.IPCPipeFile

org.alfresco.jlan.client.admin.EventlogPipeFile

public class EventlogPipeFile
extends IPCPipeFile

Eventlog Pipe File Class

Contains methods to access a remote eventlog service.

Constructor Summary

Constructors

Constructor and Description
EventlogPipeFile(IPCSession sess, DCEPacket pkt, int handle, java.lang.String name, int maxTx, int maxRx) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	closeEventlog(EventlogHandle handle) Close the event log
int	getNumberOfRecords(EventlogHandle handle) Return the number of available event log records for the specified log
int	getOldestRecordNumber(EventlogHandle handle) Return the oldest record number for the specified log
EventlogHandle	openEventLog(java.lang.String name) Open the specified event log
EventlogRecordList	readContinueEventLog(EventlogHandle handle) Continue reading event log records
EventlogRecordList	readEventLog(EventlogHandle handle, int flags, int recoff) Read event log records

Methods inherited from class org.alfresco.jlan.client.admin.IPCPipeFile

checkStatus, ClosePipe, doDCERequest, doDCERequest, getBuffer, getCallId, getHandle, getMaximumReceiveSize, getMaximumTransmitSize, getNextCallId, getPacket, getPipeName, getRxBuffer, getSession, isClosed, setMaximumReceiveSize, setMaximumTransmitSize, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EventlogPipeFile

public EventlogPipeFile(IPCSession sess,
                DCEPacket pkt,
                int handle,
                java.lang.String name,
                int maxTx,
                int maxRx)

Class constructor

Parameters:

sess - SMBIPCSession

pkt - DCEPacket

handle - int

name - String

maxTxSize - int

maxRxSize - int

Method Detail

openEventLog

public final EventlogHandle openEventLog(java.lang.String name)
                                  throws java.io.IOException,
                                         SMBException

Open the specified event log

Parameters:

name - String

Returns:

EventlogHandle

Throws:

java.io.IOException

SMBException

getNumberOfRecords

public final int getNumberOfRecords(EventlogHandle handle)
                             throws java.io.IOException,
                                    SMBException

Return the number of available event log records for the specified log

Parameters:

handle - EventlogHandle

Returns:

int

Throws:

java.io.IOException

SMBException

getOldestRecordNumber

public final int getOldestRecordNumber(EventlogHandle handle)
                                throws java.io.IOException,
                                       SMBException

Return the oldest record number for the specified log

Parameters:

handle - EventlogHandle

Returns:

int

Throws:

java.io.IOException

SMBException

readContinueEventLog

public final EventlogRecordList readContinueEventLog(EventlogHandle handle)
                                              throws java.io.IOException,
                                                     SMBException

Continue reading event log records

Parameters:

handle - EventlogHandle

Throws:

java.io.IOException

SMBException

readEventLog

public final EventlogRecordList readEventLog(EventlogHandle handle,
                              int flags,
                              int recoff)
                                      throws java.io.IOException,
                                             SMBException

Read event log records

Parameters:

handle - EventlogHandle

flags - int

recoff - int

Throws:

java.io.IOException

SMBException

closeEventlog

public final void closeEventlog(EventlogHandle handle)
                         throws java.io.IOException,
                                SMBException

Close the event log

Parameters:

handle - EventlogHandle

Throws:

java.io.IOException

SMBException