ifs.fnd.proxy

Class ProxyConnection

java.lang.Object

ifs.fnd.proxy.ProxyConnection

public class ProxyConnection
extends java.lang.Object

Database connection used in proxy-user mode.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCursor(java.lang.String cursorId, ProxyCursor cursor) Adds an open cursor to this proxy session.
boolean	closeCursor(java.lang.String cursorId) Closes a cursor identified by specified cursor ID.
void	commit() Commits the transaction on this connection.
void	executeOnClose(java.lang.String plsql) Registers PLSQL block to be executed before closing this connection.
java.sql.Connection	getConnection() Gets the wrapped Connection.
ProxyCursor	getCursor(java.lang.String cursorId) Gets an open cursor identified by specified cursor ID.
long	getDedicatedConnectionTimestamp() Gets the last-access timestamp for this dedicated connection.
java.lang.String	getEndUser() Gets the end user for this proxy session.
java.lang.String	getFndUser() Gets FND user for this proxy session.
java.lang.String	getLanguage() Gets the language for this proxy session.
java.lang.String	getSessionId() Gets the session ID for this proxy session.
boolean	inCleanupQueue() Checks if this connection is on the cleanup queue.
boolean	isDedicated() Indicate if this connection is a dedicated connection.
void	rollback() Rolls back the transaction on this connection.
void	setDedicated(boolean flag) Mark this connection as a dedicated connection.
void	setEndUser(java.lang.String endUser) Sets the end user for this proxy session.
void	setFndUser(java.lang.String fndUser) Sets FND user for this proxy session.
void	setInCleanupQueue(boolean flag) Sets inCleanupQueue-status of this connection.
void	setSessionId(java.lang.String sessionId) Sets the session ID for this proxy session.
void	setUsedByRequest(boolean flag) Sets usedByRequest-status of this connection.
java.lang.String	toString() Returns string describing this proxy connection.
void	touchCursor(java.lang.String cursorId) Mark the cursor as being accessed by the current request.
void	touchDedicatedConnection() Update the last-access timestamp for this dedicated connection.
boolean	usedByRequest() Checks if this connection is used by a request thread.

Methods inherited from class java.lang.Object

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

Method Detail

touchCursor

public void touchCursor(java.lang.String cursorId)

Mark the cursor as being accessed by the current request.

Parameters:

cursorId - client-specific ID for a cursor

setDedicated

public void setDedicated(boolean flag)

Mark this connection as a dedicated connection. A dedicated connection is kept in connection pool and is used only by one client - the connection owner.

Parameters:

flag - true to mark this connection as dedicated, false to clear this flag

isDedicated

public boolean isDedicated()

Indicate if this connection is a dedicated connection. A dedicated connection is kept in connection pool and is used only by one client - the connection owner.

Returns:

true if this connection is a dedicated connection, false otherwise

touchDedicatedConnection

public void touchDedicatedConnection()

Update the last-access timestamp for this dedicated connection.

getDedicatedConnectionTimestamp

public long getDedicatedConnectionTimestamp()

Gets the last-access timestamp for this dedicated connection.

Returns:

"computer time" measured in milliseconds

setUsedByRequest

public void setUsedByRequest(boolean flag)

Sets usedByRequest-status of this connection.

Parameters:

flag - true, to mark the connection as being in use by a request thread, false otherwise

usedByRequest

public boolean usedByRequest()

Checks if this connection is used by a request thread.

Returns:

true if a request thread is currently using this connection, false otherwise

setInCleanupQueue

public void setInCleanupQueue(boolean flag)

Sets inCleanupQueue-status of this connection.

Parameters:

flag - true, to mark the connection as waiting for cleanup on the cleanup queue, false otherwise

inCleanupQueue

public boolean inCleanupQueue()

Checks if this connection is on the cleanup queue.

Returns:

true if the connection is waiting for cleanup on the cleanup queue, false otherwise

setFndUser

public void setFndUser(java.lang.String fndUser)

Sets FND user for this proxy session.

Parameters:

fndUser - FND user running this proxy session

getFndUser

public java.lang.String getFndUser()

Gets FND user for this proxy session.

Returns:

FND user running this proxy session

getConnection

public java.sql.Connection getConnection()

Gets the wrapped Connection.

Returns:

the underlying JDBC connection

setEndUser

public void setEndUser(java.lang.String endUser)

Sets the end user for this proxy session.

Parameters:

endUser - end user running this proxy session

getEndUser

public java.lang.String getEndUser()

Gets the end user for this proxy session.

Returns:

the end user

getLanguage

public java.lang.String getLanguage()

Gets the language for this proxy session.

Returns:

the language code

getSessionId

public java.lang.String getSessionId()

Gets the session ID for this proxy session.

Returns:

the session ID

setSessionId

public void setSessionId(java.lang.String sessionId)

Sets the session ID for this proxy session.

Parameters:

sessionId - session ID

addCursor

public void addCursor(java.lang.String cursorId,
             ProxyCursor cursor)
               throws java.sql.SQLException

Adds an open cursor to this proxy session.

Parameters:

cursorId - string identifying the cursor

cursor - an instance representing an open cursor

Throws:

java.sql.SQLException - if a JDBC error occurs

getCursor

public ProxyCursor getCursor(java.lang.String cursorId)

Gets an open cursor identified by specified cursor ID.

Parameters:

cursorId - string identifying the cursor

Returns:

an instance representing an open cursor

closeCursor

public boolean closeCursor(java.lang.String cursorId)
                    throws java.sql.SQLException

Closes a cursor identified by specified cursor ID.

Parameters:

cursorId - string identifying the cursor to close

Returns:

true id the cursor has been closed, false if the specified cursor ID has not been found

Throws:

java.sql.SQLException - if a JDBC error occurs

commit

public void commit()
            throws java.sql.SQLException

Commits the transaction on this connection.

Throws:

java.sql.SQLException - if a JDBC error occurs

rollback

public void rollback()
              throws java.sql.SQLException

Rolls back the transaction on this connection.

Throws:

java.sql.SQLException - if a JDBC error occurs

toString

public java.lang.String toString()

Returns string describing this proxy connection.

Overrides:

toString in class java.lang.Object

Returns:

string describing all parameters of this proxy connection

executeOnClose

public void executeOnClose(java.lang.String plsql)

Registers PLSQL block to be executed before closing this connection.

Parameters:

plsql - PLSQL block