public class DctmSessionFactory
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
static void |
cleanupDctmTickets()
Remove stored Documentum sessions older than expiration time span.
|
static boolean |
clearDctmTicket(java.lang.String ticket)
Remove a Documentum session.
|
static boolean |
containsDctmTicket(java.lang.String ticket)
Determines whether the dctm session ticket is active.
|
static boolean |
endSession(com.documentum.fc.client.IDfSession session)
Convenience method for ending a session not involving a transaction.
|
static boolean |
endSession(com.documentum.fc.client.IDfSession session,
boolean commitTrans)
Convenience method for ending a session.
|
static java.util.Hashtable<java.lang.String,java.lang.Object> |
getDctmTicket(java.lang.String ticket)
Return a Documentum session.
|
static java.lang.String |
getNewTicketId() |
static com.documentum.fc.client.IDfSession |
getSession(java.lang.String ticket)
Convenience method for getting a documentum session not involving a
transaction.
|
static com.documentum.fc.client.IDfSession |
getSession(java.lang.String ticket,
boolean beginTrans)
Convenience method for getting a documentum session, and possibly starting
a transaction.
|
static com.documentum.fc.common.IDfLoginInfo |
getTicketLoginInfo(java.lang.String ticket)
Convenience method for retrieving login ticket information
|
static void |
setDctmTicket(java.lang.String ticket,
com.documentum.fc.client.IDfSessionManager sessionManager,
java.lang.String docbase)
Store a new Documentum session.
|
public static void setDctmTicket(java.lang.String ticket, com.documentum.fc.client.IDfSessionManager sessionManager, java.lang.String docbase)
ticket
- Unique ticket that identifies this sessionsessionManager
- Associated Session Managerdocbase
- Associated DocBasejava.lang.IllegalArgumentException
- if the specified ticket already existspublic static boolean clearDctmTicket(java.lang.String ticket)
ticket
- Unique ticket that identifies this sessionpublic static boolean containsDctmTicket(java.lang.String ticket)
ticket
- the ticket we wish to validatepublic static java.util.Hashtable<java.lang.String,java.lang.Object> getDctmTicket(java.lang.String ticket)
ticket
- Unique ticket that identifies this sessionpublic static java.lang.String getNewTicketId()
public static void cleanupDctmTickets()
public static com.documentum.fc.client.IDfSession getSession(java.lang.String ticket) throws com.documentum.fc.common.DfException
ticket
- a valid documentum ticketjava.lang.IllegalArgumentException
- if the ticket was not found or validcom.documentum.fc.common.DfException
- if there was an error acquiring the sessionpublic static com.documentum.fc.client.IDfSession getSession(java.lang.String ticket, boolean beginTrans) throws com.documentum.fc.common.DfException
ticket
- a valid documentum ticketbeginTrans
- whether to start a transactionjava.lang.IllegalArgumentException
- if the ticket was not found or validcom.documentum.fc.common.DfException
- if there was an error acquiring the sessionpublic static boolean endSession(com.documentum.fc.client.IDfSession session)
session
- session to releasepublic static boolean endSession(com.documentum.fc.client.IDfSession session, boolean commitTrans)
session
- session to releasecommitTrans
- whether to commit an outstanding transactionpublic static com.documentum.fc.common.IDfLoginInfo getTicketLoginInfo(java.lang.String ticket)
ticket
- ticket assigned from login