openlsm.web.client.LSMWebGet Class Reference

Inheritance diagram for openlsm.web.client.LSMWebGet:

[legend]

Collaboration diagram for openlsm.web.client.LSMWebGet:

[legend]

List of all members.

---

Detailed Description

Get functions for LSD in Web

Author:

Frederic Bregier LGPL

Static Public Member Functions
static int	getDocument (ArrayList< String > erreurs, LSDDbAdmin admin, long legacy, LSDBusiness lsdb, LSDDbIpPort ipport, HttpServletResponse response, boolean inline, String name)
static int	getPoolDocument (ArrayList< String > erreurs, LSDDbAdmin admin, long legacy, LSDBusiness lsdb, LSDDbIpPort ipport, HttpServletResponse response, boolean inline, String name)
static int	getDocument (ArrayList< String > erreurs, LSDDbAdmin admin, long legacy, LSDBusiness lsdb, LSDDbIpPort ipport, HttpServletResponse response)
static int	getPoolDocument (ArrayList< String > erreurs, LSDDbAdmin admin, long legacy, LSDBusiness lsdb, LSDDbIpPort ipport, HttpServletResponse response)
static int	getDocumentException (ArrayList< String > erreurs, LSDDbAdmin admin, long legacy, LSDBusiness lsdb, LSDDbIpPort ipport, HttpServletResponse response) throws LSDNoConnexionException, LSDServletOutputStreamException, LSDBadRequestException, LSDInternalException, LSDNotFoundException, LSDUnknownException
static int	getPoolDocumentException (ArrayList< String > erreurs, LSDDbAdmin admin, long legacy, LSDBusiness lsdb, LSDDbIpPort ipport, HttpServletResponse response) throws LSDNoConnexionException, LSDServletOutputStreamException, LSDBadRequestException, LSDInternalException, LSDNotFoundException, LSDUnknownException
static void	closeAll ()
Static Public Attributes
static final LSDWebClientGetPool	pool = new LSDWebClientGetPool()
Static Private Member Functions
static int	getDocumentInternal (ArrayList< String > erreurs, LSDDbAdmin admin, long legacy, LSDBusiness lsdb, HttpServletResponse response, boolean inline, String name, LSDWebClientGet lcg)

---

Member Function Documentation

static int openlsm.web.client.LSMWebGet.getDocument	(	ArrayList< String >	erreurs,
		LSDDbAdmin	admin,
		long	legacy,
		LSDBusiness	lsdb,
		LSDDbIpPort	ipport,
		HttpServletResponse	response,
		boolean	inline,
		String	name
	)			[static]

Get the document and returns it to the response

Parameters:

	erreurs	is an arrayList of Strings that will contains litteral of errors if any
	admin
	legacy
	lsdb
	ipport
	response
	inline	Set to True if the response should be opened inside the Browser (no header, no attachment available) or set Open to False if the response should be opened in the email client.
	name	Name for the email (without extension)

Returns:

0 if OK, else > 0 means an error occurs (1:no connection to OpenLSD Server, 2:document is not found in database, 3:cannot get ServletOutputStream, 4-9:no document in OpenLSD Server is returned and ServletOutputStream is not closed (client must close it by getting it again through response.getOutputStream() and then response.close()) 4: bad write to HttpServletResponse so no message could be returned to the user, 5: bad request (data given as argument are erroneous), 6: no connection (same as 1), 7: system internal error, 8: no file found (at least not in this Legacy server), 9: unknown error (as 7))

static int openlsm.web.client.LSMWebGet.getPoolDocument	(	ArrayList< String >	erreurs,
		LSDDbAdmin	admin,
		long	legacy,
		LSDBusiness	lsdb,
		LSDDbIpPort	ipport,
		HttpServletResponse	response,
		boolean	inline,
		String	name
	)			[static]

Get the document and returns it to the response using Pool

Parameters:

	erreurs	is an arrayList of Strings that will contains litteral of errors if any
	admin
	legacy
	lsdb
	ipport
	response
	inline	Set to True if the response should be opened inside the Browser (no header, no attachment available) or set Open to False if the response should be opened in the email client.
	name	Name for the email (without extension)

Returns:

0 if OK, else > 0 means an error occurs (1:no connection to OpenLSD Server, 2:document is not found in database, 3:cannot get ServletOutputStream, 4-9:no document in OpenLSD Server is returned and ServletOutputStream is not closed (client must close it by getting it again through response.getOutputStream() and then response.close()) 4: bad write to HttpServletResponse so no message could be returned to the user, 5: bad request (data given as argument are erroneous), 6: no connection (same as 1), 7: system internal error, 8: no file found (at least not in this Legacy server), 9: unknown error (as 7))

static int openlsm.web.client.LSMWebGet.getDocumentInternal	(	ArrayList< String >	erreurs,
		LSDDbAdmin	admin,
		long	legacy,
		LSDBusiness	lsdb,
		HttpServletResponse	response,
		boolean	inline,
		String	name,
		LSDWebClientGet	lcg
	)			[static, private]

Get the document: internal function

Parameters:

	erreurs
	admin
	legacy
	lsdb
	response
	inline
	name
	lcg

Returns:

0 if OK, else > 0 means an error occurs (1:no connection to OpenLSD Server, 2:document is not found in database, 3:cannot get ServletOutputStream, else return value from getNoAckDataToObject()

static int openlsd.web.appli.LSDWebGet.getDocument	(	ArrayList< String >	erreurs,
		LSDDbAdmin	admin,
		long	legacy,
		LSDBusiness	lsdb,
		LSDDbIpPort	ipport,
		HttpServletResponse	response
	)			[static, inherited]

Get the document and returns it to the response

Parameters:

	erreurs	is an arrayList of Strings that will contains litteral of errors if any
	admin
	legacy
	lsdb
	ipport
	response

Returns:

0 if OK, else > 0 means an error occurs (1:no connection to OpenLSD Server, 4-9:no document in OpenLSD Server is returned and ServletOutputStream is not closed (client must close it by getting it again through response.getOutputStream() and then response.close()) 4: bad write to HttpServletResponse so no message could be returned to the user, 5: bad request (data given as argument are erroneous), 6: no connection (same as 1), 7: system internal error, 8: no file found (at least not in this Legacy server), 9: unknown error (as 7))

static int openlsd.web.appli.LSDWebGet.getPoolDocument	(	ArrayList< String >	erreurs,
		LSDDbAdmin	admin,
		long	legacy,
		LSDBusiness	lsdb,
		LSDDbIpPort	ipport,
		HttpServletResponse	response
	)			[static, inherited]

Get the document and returns it to the response using Pool

Parameters:

	erreurs	is an arrayList of Strings that will contains litteral of errors if any
	admin
	legacy
	lsdb
	ipport
	response

Returns:

0 if OK, else > 0 means an error occurs (1:no connection to OpenLSD Server, 4-9:no document in OpenLSD Server is returned and ServletOutputStream is not closed (client must close it by getting it again through response.getOutputStream() and then response.close()) 4: bad write to HttpServletResponse so no message could be returned to the user, 5: bad request (data given as argument are erroneous), 6: no connection (same as 1), 7: system internal error, 8: no file found (at least not in this Legacy server), 9: unknown error (as 7))

static int openlsd.web.appli.LSDWebGet.getDocumentException	(	ArrayList< String >	erreurs,
		LSDDbAdmin	admin,
		long	legacy,
		LSDBusiness	lsdb,
		LSDDbIpPort	ipport,
		HttpServletResponse	response
	)			throws LSDNoConnexionException, LSDServletOutputStreamException, LSDBadRequestException, LSDInternalException, LSDNotFoundException, LSDUnknownException [static, inherited]

Get the document and returns it to the response

Parameters:

	erreurs	is an arrayList of Strings that will contains litteral of errors if any
	admin
	legacy
	lsdb
	ipport
	response

Returns:

0 if OK, else Throws one of the error Exception

Exceptions:

	LSDNoConnexionException	No connection to OpenIDM Server
	LSDServletOutputStreamException	Bad write to HttpServletResponse
	LSDBadRequestException	Bad request as data given as argument are erroneous
	LSDInternalException	Internal IDM error
	LSDNotFoundException	File not found
	LSDUnknownException	Unknown error

static int openlsd.web.appli.LSDWebGet.getPoolDocumentException	(	ArrayList< String >	erreurs,
		LSDDbAdmin	admin,
		long	legacy,
		LSDBusiness	lsdb,
		LSDDbIpPort	ipport,
		HttpServletResponse	response
	)			throws LSDNoConnexionException, LSDServletOutputStreamException, LSDBadRequestException, LSDInternalException, LSDNotFoundException, LSDUnknownException [static, inherited]

Get the document and returns it to the response using Pool

Parameters:

	erreurs	is an arrayList of Strings that will contains litteral of errors if any
	admin
	legacy
	lsdb
	ipport
	response

Returns:

0 if OK, else Throws one of the error Exception

Exceptions:

	LSDNoConnexionException	No connection to OpenIDM Server
	LSDServletOutputStreamException	Bad write to HttpServletResponse
	LSDBadRequestException	Bad request as data given as argument are erroneous
	LSDInternalException	Internal IDM error
	LSDNotFoundException	File not found
	LSDUnknownException	Unknown error

static void openlsd.web.appli.LSDWebGet.closeAll

(

)

[static, inherited]

Close all connection in Pools

---

Member Data Documentation

final LSDWebClientGetPool openlsd.web.appli.LSDWebGet.pool = new LSDWebClientGetPool() [static, inherited]

Pool of WebGet Client

---

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

• OpenLSM/BusinessLSM/openlsm/web/client/LSMWebGet.java