com.marklogic.ps

Class Session

java.lang.Object

com.marklogic.ps.Session

All Implemented Interfaces:

com.marklogic.xcc.Session, java.io.Closeable, java.lang.AutoCloseable

public class Session
extends java.lang.Object
implements com.marklogic.xcc.Session

Nested Class Summary

Nested classes/interfaces inherited from interface com.marklogic.xcc.Session

com.marklogic.xcc.Session.TransactionMode, com.marklogic.xcc.Session.Update

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	XQUERY_VERSION_1_0_ML

Constructor Summary

Constructors

Constructor and Description
Session(Connection conn, com.marklogic.xcc.Session session)

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	commit()
void	deleteCollection(java.lang.String uri)
void	deleteDocument(java.lang.String uri)
boolean	existsDocument(java.lang.String uri)
java.math.BigInteger[]	forestNamesToIds(java.lang.String[] names)
int	getCachedTxnTimeout()
java.net.URI	getConnectionUri()
com.marklogic.xcc.ContentbaseMetaData	getContentbaseMetaData()
java.lang.String	getContentBaseName()
Connection	getContentSource()
long	getCount()
java.math.BigInteger	getCurrentServerPointInTime()
com.marklogic.xcc.RequestOptions	getDefaultRequestOptions()
com.marklogic.xcc.RequestOptions	getEffectiveRequestOptions()
java.util.Map<java.lang.String,java.math.BigInteger>	getForestMap()
java.util.logging.Logger	getLogger()
com.marklogic.xcc.Session.TransactionMode	getTransactionMode() Deprecated.
int	getTransactionTimeout() Get the current transaction timeout.
com.marklogic.xcc.Session.Update	getUpdate()
com.marklogic.xcc.UserCredentials	getUserCredentials()
java.lang.Object	getUserObject()
javax.transaction.xa.XAResource	getXAResource() Returns an instance of the XAResource interface, specific to this Session object.
void	insertContent(com.marklogic.xcc.Content content)
void	insertContent(com.marklogic.xcc.Content[] content)
java.util.List<com.marklogic.xcc.exceptions.RequestException>	insertContentCollectErrors(com.marklogic.xcc.Content[] content)
boolean	isAutoCommit()
boolean	isClosed()
com.marklogic.xcc.AdhocQuery	newAdhocQuery(java.lang.String queryText)
com.marklogic.xcc.AdhocQuery	newAdhocQuery(java.lang.String queryText, com.marklogic.xcc.RequestOptions options)
com.marklogic.xcc.ModuleInvoke	newModuleInvoke(java.lang.String moduleUri)
com.marklogic.xcc.ModuleInvoke	newModuleInvoke(java.lang.String moduleUri, com.marklogic.xcc.RequestOptions options)
com.marklogic.xcc.ModuleSpawn	newModuleSpawn(java.lang.String moduleUri)
com.marklogic.xcc.ModuleSpawn	newModuleSpawn(java.lang.String moduleUri, com.marklogic.xcc.RequestOptions options)
void	rollback()
void	setAutoCommit(boolean autoCommit)
void	setDefaultRequestOptions(com.marklogic.xcc.RequestOptions options)
void	setDocumentProperties(java.lang.String uri, java.lang.String xmlString)
void	setLogger(java.util.logging.Logger logger)
void	setTransactionMode(com.marklogic.xcc.Session.TransactionMode mode) Deprecated.
void	setTransactionTimeout(int seconds) Sets the timeout for transactions
void	setUpdate(com.marklogic.xcc.Session.Update update)
void	setUserObject(java.lang.Object userObject)
com.marklogic.xcc.ResultSequence	submitRequest(com.marklogic.xcc.Request request)

Methods inherited from class java.lang.Object

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

Field Detail

XQUERY_VERSION_1_0_ML

public static final java.lang.String XQUERY_VERSION_1_0_ML

See Also:

Constant Field Values

Constructor Detail

Session

public Session(Connection conn,
               com.marklogic.xcc.Session session)

Parameters:

session -

Method Detail

getContentSource

public Connection getContentSource()

Specified by:

getContentSource in interface com.marklogic.xcc.Session

getUserCredentials

public com.marklogic.xcc.UserCredentials getUserCredentials()

Specified by:

getUserCredentials in interface com.marklogic.xcc.Session

getContentBaseName

public java.lang.String getContentBaseName()

Specified by:

getContentBaseName in interface com.marklogic.xcc.Session

commit

public boolean commit()
               throws com.marklogic.xcc.exceptions.RequestException

Specified by:

commit in interface com.marklogic.xcc.Session

Throws:

com.marklogic.xcc.exceptions.RequestException

rollback

public void rollback()
              throws com.marklogic.xcc.exceptions.RequestException

Specified by:

rollback in interface com.marklogic.xcc.Session

Throws:

com.marklogic.xcc.exceptions.RequestException

close

public void close()

Specified by:

close in interface com.marklogic.xcc.Session

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

isAutoCommit

public boolean isAutoCommit()

Specified by:

isAutoCommit in interface com.marklogic.xcc.Session

isClosed

public boolean isClosed()

Specified by:

isClosed in interface com.marklogic.xcc.Session

submitRequest

public com.marklogic.xcc.ResultSequence submitRequest(com.marklogic.xcc.Request request)
                                               throws com.marklogic.xcc.exceptions.RequestException

Specified by:

submitRequest in interface com.marklogic.xcc.Session

Throws:

com.marklogic.xcc.exceptions.RequestException

newAdhocQuery

public com.marklogic.xcc.AdhocQuery newAdhocQuery(java.lang.String queryText,
                                                  com.marklogic.xcc.RequestOptions options)

Specified by:

newAdhocQuery in interface com.marklogic.xcc.Session

newAdhocQuery

public com.marklogic.xcc.AdhocQuery newAdhocQuery(java.lang.String queryText)

Specified by:

newAdhocQuery in interface com.marklogic.xcc.Session

newModuleInvoke

public com.marklogic.xcc.ModuleInvoke newModuleInvoke(java.lang.String moduleUri,
                                                      com.marklogic.xcc.RequestOptions options)

Specified by:

newModuleInvoke in interface com.marklogic.xcc.Session

newModuleInvoke

public com.marklogic.xcc.ModuleInvoke newModuleInvoke(java.lang.String moduleUri)

Specified by:

newModuleInvoke in interface com.marklogic.xcc.Session

newModuleSpawn

public com.marklogic.xcc.ModuleSpawn newModuleSpawn(java.lang.String moduleUri,
                                                    com.marklogic.xcc.RequestOptions options)

Specified by:

newModuleSpawn in interface com.marklogic.xcc.Session

newModuleSpawn

public com.marklogic.xcc.ModuleSpawn newModuleSpawn(java.lang.String moduleUri)

Specified by:

newModuleSpawn in interface com.marklogic.xcc.Session

insertContent

public void insertContent(com.marklogic.xcc.Content content)
                   throws com.marklogic.xcc.exceptions.RequestException

Specified by:

insertContent in interface com.marklogic.xcc.Session

Throws:

com.marklogic.xcc.exceptions.RequestException

insertContent

public void insertContent(com.marklogic.xcc.Content[] content)
                   throws com.marklogic.xcc.exceptions.RequestException

Specified by:

insertContent in interface com.marklogic.xcc.Session

Throws:

com.marklogic.xcc.exceptions.RequestException

insertContentCollectErrors

public java.util.List<com.marklogic.xcc.exceptions.RequestException> insertContentCollectErrors(com.marklogic.xcc.Content[] content)

Specified by:

insertContentCollectErrors in interface com.marklogic.xcc.Session

getContentbaseMetaData

public com.marklogic.xcc.ContentbaseMetaData getContentbaseMetaData()

Specified by:

getContentbaseMetaData in interface com.marklogic.xcc.Session

setAutoCommit

public void setAutoCommit(boolean autoCommit)

Specified by:

setAutoCommit in interface com.marklogic.xcc.Session

setDefaultRequestOptions

public void setDefaultRequestOptions(com.marklogic.xcc.RequestOptions options)

Specified by:

setDefaultRequestOptions in interface com.marklogic.xcc.Session

getDefaultRequestOptions

public com.marklogic.xcc.RequestOptions getDefaultRequestOptions()

Specified by:

getDefaultRequestOptions in interface com.marklogic.xcc.Session

setUpdate

public void setUpdate(com.marklogic.xcc.Session.Update update)

Specified by:

setUpdate in interface com.marklogic.xcc.Session

getUpdate

public com.marklogic.xcc.Session.Update getUpdate()

Specified by:

getUpdate in interface com.marklogic.xcc.Session

getEffectiveRequestOptions

public com.marklogic.xcc.RequestOptions getEffectiveRequestOptions()

Specified by:

getEffectiveRequestOptions in interface com.marklogic.xcc.Session

getCurrentServerPointInTime

public java.math.BigInteger getCurrentServerPointInTime()
                                                 throws com.marklogic.xcc.exceptions.RequestException

Specified by:

getCurrentServerPointInTime in interface com.marklogic.xcc.Session

Throws:

com.marklogic.xcc.exceptions.RequestException

getLogger

public java.util.logging.Logger getLogger()

Specified by:

getLogger in interface com.marklogic.xcc.Session

setLogger

public void setLogger(java.util.logging.Logger logger)

Specified by:

setLogger in interface com.marklogic.xcc.Session

setUserObject

public void setUserObject(java.lang.Object userObject)

Specified by:

setUserObject in interface com.marklogic.xcc.Session

getUserObject

public java.lang.Object getUserObject()

Specified by:

getUserObject in interface com.marklogic.xcc.Session

existsDocument

public boolean existsDocument(java.lang.String uri)
                       throws com.marklogic.xcc.exceptions.XccException

Throws:

com.marklogic.xcc.exceptions.XccException

getCount

public long getCount()
              throws com.marklogic.xcc.exceptions.XccException

Throws:

com.marklogic.xcc.exceptions.XccException

deleteDocument

public void deleteDocument(java.lang.String uri)
                    throws com.marklogic.xcc.exceptions.XccException

Parameters:

uri -

Throws:

com.marklogic.xcc.exceptions.XccException

deleteCollection

public void deleteCollection(java.lang.String uri)
                      throws com.marklogic.xcc.exceptions.XccException

Parameters:

uri -

Throws:

com.marklogic.xcc.exceptions.XccException

setDocumentProperties

public void setDocumentProperties(java.lang.String uri,
                                  java.lang.String xmlString)
                           throws com.marklogic.xcc.exceptions.XccException

Parameters:

uri -

xmlString -

Throws:

com.marklogic.xcc.exceptions.XccException

getForestMap

public java.util.Map<java.lang.String,java.math.BigInteger> getForestMap()
                                                                  throws com.marklogic.xcc.exceptions.XccException

Returns:

Throws:

com.marklogic.xcc.exceptions.XccException

forestNamesToIds

public java.math.BigInteger[] forestNamesToIds(java.lang.String[] names)
                                        throws com.marklogic.xcc.exceptions.XccException

Parameters:

names -

Returns:

Throws:

com.marklogic.xcc.exceptions.XccException

getConnectionUri

public java.net.URI getConnectionUri()

Specified by:

getConnectionUri in interface com.marklogic.xcc.Session

setTransactionMode

@Deprecated
public void setTransactionMode(com.marklogic.xcc.Session.TransactionMode mode)

Deprecated.

Sets the transaction mode to the given value. The initial value is TransactionMode.AUTO.

If the transaction mode is TransactionMode.AUTO, a new transaction is created for every request, and committed (or rolled back) at the end of that request. The type of transaction created is determined automatically by query analysis.

If transaction mode is TransactionMode.QUERY or TransactionMode.UPDATE, requests are grouped under transactions bounded by calls to Session.commit() or Session.rollback(). If transaction mode is TransactionMode.QUERY, then a read-only query transaction is created to group requests. If transaction mode is TransactionMode.UPDATE, then a locking update transaction is created. If an updating request is executed under a read-only TransactionMode.QUERY transaction, a RequestException is thrown.

Calling setTransactionMode() while a transaction is active has no effect on the current transaction.

Specified by:

setTransactionMode in interface com.marklogic.xcc.Session

Parameters:

mode - The new transaction mode

getTransactionMode

@Deprecated
public com.marklogic.xcc.Session.TransactionMode getTransactionMode()

Deprecated.

Get the current transaction mode.

Specified by:

getTransactionMode in interface com.marklogic.xcc.Session

Returns:

The current transaction mode setting.

setTransactionTimeout

public void setTransactionTimeout(int seconds)
                           throws com.marklogic.xcc.exceptions.RequestException

Sets the timeout for transactions

Specified by:

setTransactionTimeout in interface com.marklogic.xcc.Session

Parameters:

seconds - The number of seconds before the transaction times out

Throws:

com.marklogic.xcc.exceptions.RequestException - If there is a problem communicating with the server.

getTransactionTimeout

public int getTransactionTimeout()
                          throws com.marklogic.xcc.exceptions.RequestException

Get the current transaction timeout.

Specified by:

getTransactionTimeout in interface com.marklogic.xcc.Session

Returns:

The current transaction timeout setting.

Throws:

com.marklogic.xcc.exceptions.RequestException - If there is a problem communicating with the server.

getXAResource

public javax.transaction.xa.XAResource getXAResource()

Returns an instance of the XAResource interface, specific to this Session object. This can be used to take part in JTA distributed transactions using an implementation of javax.transaction.TransactionManager.

Specified by:

getXAResource in interface com.marklogic.xcc.Session

Returns:

The XAResource object.

getCachedTxnTimeout

public int getCachedTxnTimeout()

Specified by:

getCachedTxnTimeout in interface com.marklogic.xcc.Session