"WEBNMS_5 API Docs"

com.adventnet.nms.tftp
Class TftpLogEvent

java.lang.Object
  extended by com.adventnet.nms.tftp.TftpLogEvent
All Implemented Interfaces:
java.io.Serializable

public class TftpLogEvent
extends java.lang.Object
implements java.io.Serializable

An event which indicates that a TFTP transaction has occurred. The registered listener will be notified of this event.

See Also:
Serialized Form

Constructor Summary
TftpLogEvent(java.lang.Object logSource)
          Constructs a TftpLogEvent.
 
Method Summary
 java.lang.String getAddress()
          Returns the IPAddress of a client which gets connected to the TFTP server for transferring files.
 int getClientCount()
          Returns the number of clients connected.
 short getCommand()
          Returns the type of Transfer( GET or PUT).
 short getErrorCode()
          Returns the code of the error.
 java.lang.String getFileName()
          Returns the source file name if the command is GET (read) or the target file name if the command is PUT (write).
 java.lang.String getMessage()
          Returns the log message which provides brief info about the Tftp Event.
 int getPort()
          Returns the port at which the server listens to each client.
 long getTime()
          Returns the time (System time) at which each logging operation took place.
 long getTransactionID()
          Returns the transactionID, which is a global number incrementing with each client getting connected.
 short getType()
          Returns the type of TFTP Message, can be one of TftpLogger.START, TftpLogger.FINISH or Tftp1350.ERROR.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TftpLogEvent

public TftpLogEvent(java.lang.Object logSource)
Constructs a TftpLogEvent.

Parameters:
logSource - the object that originated this event.
Method Detail

getTransactionID

public long getTransactionID()
Returns the transactionID, which is a global number incrementing with each client getting connected.

Returns:
the transactionID of a client.

getTime

public long getTime()
Returns the time (System time) at which each logging operation took place.

Returns:
the difference, measured in milliseconds, between the current time and midnight, January 1970 UTC.

getCommand

public short getCommand()
Returns the type of Transfer( GET or PUT).

Returns:
a short which represents the TFTP command.
See Also:
Tftp1350

getAddress

public java.lang.String getAddress()
Returns the IPAddress of a client which gets connected to the TFTP server for transferring files.

Returns:
the address of a client.

getPort

public int getPort()
Returns the port at which the server listens to each client.

Returns:
the port at which the server is listening.

getFileName

public java.lang.String getFileName()
Returns the source file name if the command is GET (read) or the target file name if the command is PUT (write).

Returns:
file name.

getMessage

public java.lang.String getMessage()
Returns the log message which provides brief info about the Tftp Event.

Returns:
a log message.
See Also:
getType()

getErrorCode

public short getErrorCode()
Returns the code of the error.

Returns:
a number which is a code for a particular type of an error.
See Also:
Tftp1350

getType

public short getType()
Returns the type of TFTP Message, can be one of TftpLogger.START, TftpLogger.FINISH or Tftp1350.ERROR.

Returns:
the type of TFTP transaction.

getClientCount

public int getClientCount()
Returns the number of clients connected.

Returns:
the number of clients that are connected to the TftpServer at that particular instant.

"WEBNMS_5 API Docs"

Copyright © 2011 ZOHO Corp., All Rights Reserved.