JMX Documentation
 
Mbeans (English)
 
  FtpServer
  ClientSession
Mbeans (French)
 
  FtpServer
 
  Built with Apache Forrest logo Financial help logo
 
Designed for Firefox logo Java.net member logo
 


PDF 

ClientSessionMBean documentation



Bean Description  > List of attributes  > List of operations  > Attributes declaration  > Operations declaration 

Bean Description

Description : A server session

Type : net.sbbi.jafs.session.ClientSession

Domain : sessions

ClassName : net.sbbi.jafs.management.ClientSessionMBean

List of attributes

averageDownloadSpeedaverageUploadSpeedcontrolSecurityProtocolcurrentCreditscurrentPathdataSecurityProtocoldownloadingDTPPorthostIpPASVModePIPortprocessedFilesessionTimetotalReadenBytestotalWrittenBytestransfertModetransfertTypeuploadinguserName

List of operations

addCreditsbanendSessionendSessionMsgremoveCreditssendMessagewhois

Attributes declaration

sessionTime

DescriptionThe session time

Typelong

Writeablefalse

userName

DescriptionThe user name used by the client

Typejava.lang.String

Writeablefalse

currentPath

DescriptionThe current location of the client on the server

Typejava.lang.String

Writeablefalse

PASVMode

DescriptionTells if the client is in PASV mode or not

Typejava.lang.Boolean

Writeablefalse

hostIp

DescriptionThe host's IP address

Typejava.lang.String

Writeablefalse

DTPPort

DescriptionThe host's DTP port address

Typejava.lang.Integer

Writeablefalse

PIPort

DescriptionThe host's PI port address

Typejava.lang.Integer

Writeablefalse

currentCredits

DescriptionThe host's current credits amount

Typejava.lang.String

Writeablefalse

uploading

DescriptionTells if the host is currently uploading a file

Typejava.lang.Boolean

Writeablefalse

averageUploadSpeed

DescriptionThe average upload speed in KB/s

Typedouble

Writeablefalse

downloading

DescriptionTells if the host is currently downloading a file

Typejava.lang.Boolean

Writeablefalse

averageDownloadSpeed

DescriptionThe average download speed in KB/s

Typedouble

Writeablefalse

processedFile

DescriptionThe current processed file if uploading or downloading

Typejava.lang.String

Writeablefalse

totalReadenBytes

DescriptionThe total amount of bytes readen so far during the session

Typejava.lang.String

Writeablefalse

totalWrittenBytes

DescriptionThe total amount of bytes written so far during the session

Typejava.lang.String

Writeablefalse

transfertType

DescriptionThe transfert type

Typejava.lang.String

Writeablefalse

transfertMode

DescriptionThe transfert mode

Typejava.lang.String

Writeablefalse

controlSecurityProtocol

DescriptionThe security protocol currently used for the control socket

Typejava.lang.String

Writeablefalse

dataSecurityProtocol

DescriptionThe security protocol currently used for the data transfert

Typejava.lang.String

Writeablefalse

Operations declaration

addCredits

DescriptionGives the client credits

Return type

ImpactACTION

Parameters
credittype: java.lang.LongThe credits amount in bytes ( 1024 = 1Kb )

removeCredits

DescriptionRemoves credits for the client

Return type

ImpactACTION

Parameters
credittype: java.lang.LongThe amount of bytes ( 1024 = 1Kb ) to remove from the client

endSession

DescriptionClose the session

Return type

ImpactACTION

endSessionMsg

DescriptionSends a message to the client and closes the session

Return type

ImpactACTION

Parameters
messagetype: java.lang.StringThe message to send

ban

DescriptionBan the client and disconnect it

Return type

ImpactACTION

Parameters
reasontype: java.lang.StringThe reason for banning

sendMessage

DescriptionSends a message to the client

Return type

ImpactACTION

Parameters
messagetype: java.lang.StringThe message to send

whois

DescriptionWHOIS query with the current client host name or its IP address

Return type

ImpactACTION


 

Copyright © 2005 SuperBonBon Industries. All rights reserved.
Unless otherwise expressly noted, the contents of these pages are licensed under the Creative Commons - Attribution / Share Alike license.