openlsd.network.client.put.LSDClientPut Class Reference

Inheritance diagram for openlsd.network.client.put.LSDClientPut:

Inheritance graph
[legend]
Collaboration diagram for openlsd.network.client.put.LSDClientPut:

Collaboration graph
[legend]

List of all members.


Detailed Description

Class LSDClientPut is the class that defines function to offer service to client part for Put.

Author:
Frederic Bregier LGPL

Public Member Functions

 LSDClientPut (LSDClientPutSessionHandler lscshext, String Hostname, int ServerPort, boolean immediate, boolean keepalived)
 LSDClientPut (String Hostname, int ServerPort, boolean immediate, boolean keepalived)
 LSDClientPut (LSDClientPutSessionHandler lscshext, String Hostname, int ServerPort, boolean ServerCompressed, boolean ClientCompressed, boolean immediate, boolean keepalived)
 LSDClientPut (String Hostname, int ServerPort, boolean ServerCompressed, boolean ClientCompressed, boolean immediate, boolean keepalived)
int putDataFromObject (boolean unique, long legacy, long storage, long document, Object object)
int putNoAckDataFromObject (boolean unique, long legacy, long storage, long document, Object object)
int putFile (boolean unique, long legacy, long storage, long document, String filepath)
void lock ()
void connect (boolean immediate, boolean keepalived)
boolean connectionJoin ()
boolean sessionReconnect ()
boolean isConnected ()
void clear ()
Object getObject ()
void setObject (Object object)
Object clearObject ()
void close ()
void realClose ()
int getStatus ()
void initShared ()
void unlock ()
String toString ()

Static Public Member Functions

static void initClient ()
static void endClient ()
static void endClient (boolean toexit)
static boolean isSessionOK (IoSession session)

Public Attributes

String md5 = null
long size = 0
String hostname = "localhost"
int serverPort = 8080
boolean serverCompressed = false
boolean clientCompressed = false
long idip = LSDConstants.invalide_idx
IoSession session = null
SocketConnector connector = null
LSDClientSession ls = null
LSDClientCommonSessionHandler lscsh = null
ExecutorService executorChainService = null
LSDPoolConnectionAbstract poolConnection = null

Protected Member Functions

LSDClientCommonSessionHandler createSessionHandler ()

Private Member Functions

void putData (boolean unique, long legacy, long storage, long document, Object object)
void putNoAckData (boolean unique, long legacy, long storage, long document, Object object)

Constructor & Destructor Documentation

openlsd.network.client.put.LSDClientPut.LSDClientPut ( LSDClientPutSessionHandler  lscshext,
String  Hostname,
int  ServerPort,
boolean  immediate,
boolean  keepalived 
)

Create a new ClientPut using a specific SessionHandler that extends the LSDClientPutSessionHandler class and a specific Hostname and serverPort.

Parameters:
lscshext 
Hostname 
ServerPort 
immediate 
keepalived 

openlsd.network.client.put.LSDClientPut.LSDClientPut ( String  Hostname,
int  ServerPort,
boolean  immediate,
boolean  keepalived 
)

Create a new ClientPut using a specific Hostname and serverPort.

Parameters:
Hostname 
ServerPort 
immediate 
keepalived 

openlsd.network.client.put.LSDClientPut.LSDClientPut ( LSDClientPutSessionHandler  lscshext,
String  Hostname,
int  ServerPort,
boolean  ServerCompressed,
boolean  ClientCompressed,
boolean  immediate,
boolean  keepalived 
)

Create a new ClientPut using a specific SessionHandler that extends the LSDClientPutSessionHandler class and a specific Hostname and serverPort and the properties of compression for server and client part.

Parameters:
lscshext 
Hostname 
ServerPort 
ServerCompressed 
ClientCompressed 
immediate 
keepalived 

openlsd.network.client.put.LSDClientPut.LSDClientPut ( String  Hostname,
int  ServerPort,
boolean  ServerCompressed,
boolean  ClientCompressed,
boolean  immediate,
boolean  keepalived 
)

Create a new ClientPut using a specific Hostname and serverPort and the properties of compression for server and client part.

Parameters:
Hostname 
ServerPort 
ServerCompressed 
ClientCompressed 
immediate 
keepalived 


Member Function Documentation

LSDClientCommonSessionHandler openlsd.network.client.put.LSDClientPut.createSessionHandler (  )  [protected, virtual]

Create a SessionHandler. This function has to be rewritten by classes that extends this one.

Returns:
a new SessionHandler

Implements openlsd.network.client.common.LSDClientCommon.

Reimplemented in openlsd.multiple.ophandler.extension.LSDPoolClientPut.

void openlsd.network.client.put.LSDClientPut.putData ( boolean  unique,
long  legacy,
long  storage,
long  document,
Object  object 
) [private]

Ask to put Data (file) identified by the triple legacy, storage and document, and put the result from the byte array (or object which implies an extend of LSDClientPutSessionHandler with a new implementation of messageNewBlock).

The boolean unique set if the get should close the connection after the full send (true), or not (false).

This function is called by other calls to put data.

This function uses acknowledge of each block.

At the end, object contains the MD5 in String and the file size.

Parameters:
unique 
legacy 
storage 
document 
object (must be not null, and by default an array of byte)

int openlsd.network.client.put.LSDClientPut.putDataFromObject ( boolean  unique,
long  legacy,
long  storage,
long  document,
Object  object 
)

Ask to put Data (file) identified by the triple legacy, storage and document, and put the result from the byte array (or object which implies an extend of LSDClientPutSessionHandler with a new implementation of messageNewBlock).

The boolean unique set if the get should close the connection after the full send (true), or not (false).

This function uses acknowledge of each block.

At the end, object contains the MD5 in String and the file size.

Parameters:
unique 
legacy 
storage 
document 
object (must be not null, and by default an array of byte)
Returns:
the status (>=0) for OK, (<0) for KO

void openlsd.network.client.put.LSDClientPut.putNoAckData ( boolean  unique,
long  legacy,
long  storage,
long  document,
Object  object 
) [private]

Ask to put Data (file) identified by the triple legacy, storage and document, and put the result from the byte array (or object which implies an extend of LSDClientPutSessionHandler with a new implementation of messageNewBlock).

The boolean unique set if the get should close the connection after the full send (true), or not (false).

This function is called by other calls to put data.

This function uses no acknowledge for each block (quicker).

At the end, object contains the MD5 in String and the file size.

Parameters:
unique 
legacy 
storage 
document 
object (must be not null, and by default an array of byte)

int openlsd.network.client.put.LSDClientPut.putNoAckDataFromObject ( boolean  unique,
long  legacy,
long  storage,
long  document,
Object  object 
)

Ask to put Data (file) identified by the triple legacy, storage and document, and put the result from the byte array (or object which implies an extend of LSDClientPutSessionHandler with a new implementation of messageNewBlock).

The boolean unique set if the get should close the connection after the full send (true), or not (false).

This function uses no acknowledge for each block (quicker).

At the end, object contains the MD5 in String and the file size.

Parameters:
unique 
legacy 
storage 
document 
object (must be not null, and by default an array of byte)
Returns:
the status (>=0) for OK, (<0) for KO

int openlsd.network.client.put.LSDClientPut.putFile ( boolean  unique,
long  legacy,
long  storage,
long  document,
String  filepath 
)

Ask to put a file from its filepath identified by the triple legacy, storage and document, and put the file from the pathfile which can be either a true access file path legal from the server or either a net access (ftp, http, ...).

The boolean unique set if the get should close the connection after the full send (true), or not (false).

At the end, object contains the MD5 in String and the file size.

Parameters:
unique 
legacy 
storage 
document 
filepath (must be not null)
Returns:
the status (>=0) for OK, (<0) for KO

Lock in case of shared connection (no synchronized since if connection are not shared, they can be done in parallel)

static void openlsd.network.client.common.LSDClientCommon.initClient (  )  [static, inherited]

Init global structure like IoBufferAllocator

static void openlsd.network.client.common.LSDClientCommon.endClient (  )  [static, inherited]

End global structure like IoBufferAllocator

static void openlsd.network.client.common.LSDClientCommon.endClient ( boolean  toexit  )  [static, inherited]

End global structure like IoBufferAllocator

Parameters:
toexit 

void openlsd.network.client.common.LSDClientCommon.connect ( boolean  immediate,
boolean  keepalived 
) [inherited]

The client is now to be connected to the server using the specific SessionHandler that extends the LSDClientCommonSessionHandler class. This function is called by the Constructor.

If the connection is not ok, then the function isConnected() returns false. The client is immediately connected if immediate is true, else it will be connected after connectionJoint() will be called.

Parameters:
immediate 
keepalived True if the chainFilter should add the keepalived feature (mandatory in immediate mode to true if the keepalived filter is wanted)

boolean openlsd.network.client.common.LSDClientCommon.connectionJoin (  )  [inherited]

Join the connection, so as to finalize the connection process

Returns:
True if OK, else false

boolean openlsd.network.client.common.LSDClientCommon.sessionReconnect (  )  [inherited]

Enable to try to reconnect to the server if disconnected.

Returns:
True if reconnected, else False

boolean openlsd.network.client.common.LSDClientCommon.isConnected (  )  [inherited]

Returns the status of the connection and clear the session if not connected (sessionStop)

Returns:
the status of the connection

static boolean openlsd.network.client.common.LSDClientCommon.isSessionOK ( IoSession  session  )  [static, inherited]

Test if the session is still OK

Parameters:
session 
Returns:
True if the session is OK, else False

void openlsd.network.client.common.LSDClientCommon.clear (  )  [inherited]

clear session information

Object openlsd.network.client.common.LSDClientCommon.getObject (  )  [inherited]

Return the current user object of the session

Returns:
the user object or null if no session or object

void openlsd.network.client.common.LSDClientCommon.setObject ( Object  object  )  [inherited]

Set the current user object of the session

Parameters:
object 

Object openlsd.network.client.common.LSDClientCommon.clearObject (  )  [inherited]

Return the current user object of the session before clear the object stored.

Returns:
the past user object or null if no session or object

void openlsd.network.client.common.LSDClientCommon.close (  )  [inherited]

void openlsd.network.client.common.LSDClientCommon.realClose (  )  [inherited]

Will totally close the current session and finalize the Client. Reconnection cannot be done.

int openlsd.network.client.common.LSDClientCommon.getStatus (  )  [inherited]

Return the status of the request: 1 running, 0 finished, -1 error system, -2 error as request, -3 error as unavailable request, -4 error as cannot restore to previous state, -5 error as bad client request, -6 error as no service.

Returns:
the status (-6 to 1)

void openlsd.network.client.common.LSDClientCommon.initShared (  )  [inherited]

Initialized a lock to enable shared connection among threads

void openlsd.network.client.common.LSDClientCommon.unlock (  )  [inherited]

UnLock in case of shared connection

String openlsd.network.client.common.LSDClientCommon.toString (  )  [inherited]

Returns:
The String of the Client


Member Data Documentation

MD5 data

Original size of the file

Hostname

Port for the server

Are messages compressed from Server

Are messages compressed from Client

Idip of server: not mandatory, should be set if needed after constructor

Associated session

SocketConnector openlsd.network.client.common.LSDClientCommon.connector = null [inherited]

Associated socket connector

Associated session info

Associated Session Handler

Associated ExecutorChainService

LSDPoolConnectionAbstract openlsd.network.client.common.LSDClientCommon.poolConnection = null [inherited]

The referent pool of connections if this connection is taken from a pool of connections


The documentation for this class was generated from the following file: