com.cleo.lexicom.external

Class LexUtil

java.lang.Object

com.cleo.lexicom.external.LexUtil

public class LexUtil
extends java.lang.Object

Miscellaneous utilities

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	beanSeparator The separator (backslash) used in host\mailbox\action and local listener\service paths

Constructor Summary

Constructors

Constructor and Description
LexUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String[]	convert(int type, java.lang.String path)
static java.lang.String	convert(int type, java.lang.String[] path)
static boolean	getAutoCommit() Get the default auto-commit for all connections returned from LexUtil
static java.sql.Connection	getDatabaseConnection() Get a connection from the VersaLex database connection pool.
static java.sql.Connection	getDatabaseConnection(boolean commit) Get a connection from the VersaLex database connection pool.
static javax.mail.Session	getSession() Vends a Java mail session object for use in sending an email out through VersaLex
static java.io.BufferedOutputStream	getSystemDebugOut() Gets the system debug output stream
static java.io.BufferedWriter	getSystemDebugWriter() Gets the system debug writer
static boolean	isCommand(org.w3c.dom.Element event) Check if log event is a Command element
static boolean	isCopyFile(java.lang.String direction) Check if local copy file
static boolean	isDetail(org.w3c.dom.Element event) Check if log event is a Detail element
static boolean	isEnd(org.w3c.dom.Element event) Check if log event is an End element
static boolean	isFailureResult(java.lang.String status) Check if Result status is a failure
static boolean	isFile(org.w3c.dom.Element event) Check if log event is a File element
static boolean	isIncomingFile(java.lang.String direction) Check if receiving file
static boolean	isOutgoingFile(java.lang.String direction) Check if sending file
static boolean	isResponse(org.w3c.dom.Element event) Check if log event is a Result element
static boolean	isResult(org.w3c.dom.Element event) Check if log event is a Result element
static boolean	isThread(org.w3c.dom.Element event) Check if log event is a Thread element
static void	putDatabaseConnection(java.sql.Connection connection) Put back a database connection into the VersaLex connection pool.
static void	putDatabaseConnection(java.sql.Connection connection, boolean commit) Put back a database connection into the VersaLex connection pool.
static void	sendMail(javax.mail.Session session, javax.mail.internet.MimeMessage message) Sends an email out through VersaLex
static void	sendMail(javax.mail.Session session, javax.mail.internet.MimeMessage message, int timeout) Sends an email out through VersaLex
static void	setAutoCommit(boolean autoCommit) Set the auto-commit status of all connections returned to auto-commit (true) or rollback (false).
static void	setDatabaseConnectionPoolSize(int poolsize) Set the database connection poolsize (defaults to 1).

Methods inherited from class java.lang.Object

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

Field Detail

beanSeparator

public static final java.lang.String beanSeparator

The separator (backslash) used in host\mailbox\action and local listener\service paths

See Also:

Constant Field Values

Constructor Detail

LexUtil

public LexUtil()

Method Detail

getSystemDebugWriter

public static final java.io.BufferedWriter getSystemDebugWriter()

Gets the system debug writer

Returns:

The system debug writer

getSystemDebugOut

public static final java.io.BufferedOutputStream getSystemDebugOut()

Gets the system debug output stream

Returns:

The system debug output stream

getSession

public static final javax.mail.Session getSession()
                                           throws java.lang.Exception

Vends a Java mail session object for use in sending an email out through VersaLex

Returns:

Java mail session

Throws:

java.lang.Exception

sendMail

public static final void sendMail(javax.mail.Session session,
                                  javax.mail.internet.MimeMessage message)
                           throws java.lang.Exception

Sends an email out through VersaLex

Parameters:

session - Java mail session

message - Java mail message originating from new MimeMessage(session)

Throws:

java.lang.Exception

sendMail

public static final void sendMail(javax.mail.Session session,
                                  javax.mail.internet.MimeMessage message,
                                  int timeout)
                           throws java.lang.Exception

Sends an email out through VersaLex

Parameters:

session - Java mail session

message - Java mail message originating from new MimeMessage(session)

timeout - Timeout in seconds for sending email (defaults to 150 seconds)

Throws:

java.lang.Exception

isThread

public static final boolean isThread(org.w3c.dom.Element event)

Check if log event is a Thread element

Parameters:

event - VersaLex Log event

Returns:

true if log event is a Thread element

isCommand

public static final boolean isCommand(org.w3c.dom.Element event)

Check if log event is a Command element

Parameters:

event - VersaLex Log event

Returns:

true if log event is a Command element

isDetail

public static final boolean isDetail(org.w3c.dom.Element event)

Check if log event is a Detail element

Parameters:

event - VersaLex Log event

Returns:

true if log event is a Detail element

isEnd

public static final boolean isEnd(org.w3c.dom.Element event)

Check if log event is an End element

Parameters:

event - VersaLex Log event

Returns:

true if log event is an End element

isFile

public static final boolean isFile(org.w3c.dom.Element event)

Check if log event is a File element

Parameters:

event - VersaLex Log event

Returns:

true if log event is a File element

isResult

public static final boolean isResult(org.w3c.dom.Element event)

Check if log event is a Result element

Parameters:

event - VersaLex Log event

Returns:

true if log event is a Result element

isResponse

public static final boolean isResponse(org.w3c.dom.Element event)

Check if log event is a Result element

Parameters:

event - VersaLex Log event

Returns:

true if log event is a Result element

isFailureResult

public static final boolean isFailureResult(java.lang.String status)

Check if Result status is a failure

Parameters:

status - Result text value

Returns:

true if status is a failure

isOutgoingFile

public static final boolean isOutgoingFile(java.lang.String direction)

Check if sending file

Parameters:

direction - Result direction value

Returns:

true if outgoing file

isIncomingFile

public static final boolean isIncomingFile(java.lang.String direction)

Check if receiving file

Parameters:

direction - Result direction value

Returns:

true if incoming file

isCopyFile

public static final boolean isCopyFile(java.lang.String direction)

Check if local copy file

Parameters:

direction - Result direction value

Returns:

true if local copy file

setAutoCommit

public static final void setAutoCommit(boolean autoCommit)

Set the auto-commit status of all connections returned to auto-commit (true) or rollback (false).

Parameters:

autoCommit - true = auto commit, false = rollback

getAutoCommit

public static final boolean getAutoCommit()

Get the default auto-commit for all connections returned from LexUtil

Returns:

true = auto commit, false = rollback

getDatabaseConnection

public static final java.sql.Connection getDatabaseConnection()
                                                       throws java.lang.Exception

Get a connection from the VersaLex database connection pool.
A connection is returned even if the connection poolsize is being exceeded.

Returns:

database connection

Throws:

java.lang.Exception

getDatabaseConnection

public static final java.sql.Connection getDatabaseConnection(boolean commit)
                                                       throws java.lang.Exception

Get a connection from the VersaLex database connection pool.
A connection is returned even if the connection poolsize is being exceeded.

Parameters:

commit - passing in a boolean overrides the default. true returns an auto commit connection, false returns a rollback connection

Returns:

database connection

Throws:

java.lang.Exception

putDatabaseConnection

public static final void putDatabaseConnection(java.sql.Connection connection)
                                        throws java.lang.Exception

Put back a database connection into the VersaLex connection pool.
For proper cleanup, even a closed or otherwise invalid connection should be put back.
In order to avoid potentially creating new connections over and over, an excessive connection is closed and removed from the pool only after an unused period has elapsed (20 minutes).

Parameters:

connection - database connection being returned to pool

Throws:

java.lang.Exception

putDatabaseConnection

public static final void putDatabaseConnection(java.sql.Connection connection,
                                               boolean commit)
                                        throws java.lang.Exception

Put back a database connection into the VersaLex connection pool.
For proper cleanup, even a closed or otherwise invalid connection should be put back.
In order to avoid potentially creating new connections over and over, an excessive connection is closed and removed from the pool only after an unused period has elapsed (20 minutes).

Parameters:

connection - database connection being returned to pool

commit - if connection.getAutoCommit() returns false, then passing true will commit the connection before adding it back to the pool. If connection.getAutoCommit() returns false and commit is false, then the connection is rolled back before returning to the pool

Throws:

java.lang.Exception

setDatabaseConnectionPoolSize

public static final void setDatabaseConnectionPoolSize(int poolsize)
                                                throws java.lang.Exception

Set the database connection poolsize (defaults to 1).

Parameters:

poolsize - (must be >= 1)

Throws:

java.lang.Exception

convert

public static final java.lang.String convert(int type,
                                             java.lang.String[] path)

convert

public static final java.lang.String[] convert(int type,
                                               java.lang.String path)