ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-02-21 09:51:57 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

CORDA-3659 - adding kdoc for RestrictedEntityManager and RestrictedConnection (#6179)

Browse Source 
* adding kdoc for RestrictedEntityManager and RestrictedConnection

* adding kdoc for RestrictedEntityManager and RestrictedConnection
This commit is contained in:
nikinagy 2020-04-28 09:35:47 +01:00 committed by GitHub
parent e6e1caa58a
commit ec96a844bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
core/src/main/kotlin/net/corda/core/node/ServiceHub.kt
View File

@ -380,6 +380,26 @@ interface ServiceHub : ServicesForResolution {
* When used within a flow, this session automatically forms part of the enclosing flow transaction boundary, * When used within a flow, this session automatically forms part of the enclosing flow transaction boundary,
* and thus queryable data will include everything committed as of the last checkpoint. * and thus queryable data will include everything committed as of the last checkpoint.
* *
* We want to make sure users have a restricted access to administrative functions, this function will return a [RestrictedConnection] instance.
* The blocked methods are the following:
* - abort(executor: Executor?)
* - clearWarnings()
* - close()
* - commit()
* - setSavepoint()
* - setSavepoint(name : String?)
* - releaseSavepoint(savepoint: Savepoint?)
* - rollback()
* - rollback(savepoint: Savepoint?)
* - setCatalog(catalog : String?)
* - setTransactionIsolation(level: Int)
* - setTypeMap(map: MutableMap<String, Class<*>>?)
* - setHoldability(holdability: Int)
* - setSchema(schema: String?)
* - setNetworkTimeout(executor: Executor?, milliseconds: Int)
* - setAutoCommit(autoCommit: Boolean)
* - setReadOnly(readOnly: Boolean)
*
* @throws IllegalStateException if called outside of a transaction. * @throws IllegalStateException if called outside of a transaction.
* @return A [Connection] * @return A [Connection]
*/ */
@ -393,6 +413,17 @@ interface ServiceHub : ServicesForResolution {
* NOTE: Suspendable flow operations such as send, receive, subFlow and sleep, cannot be called within the lambda. * NOTE: Suspendable flow operations such as send, receive, subFlow and sleep, cannot be called within the lambda.
* *
* @param block a lambda function with access to an [EntityManager]. * @param block a lambda function with access to an [EntityManager].
*
* We want to make sure users have a restricted access to administrative functions.
* The blocked methods are the following:
* - close()
* - clear()
* - getMetamodel()
* - getTransaction()
* - joinTransaction()
* - lock(entity: Any?, lockMode: LockModeType?)
* - lock(entity: Any?, lockMode: LockModeType?, properties: MutableMap<String, Any>?)
* - setProperty(propertyName: String?, value: Any?)
*/ */
fun <T : Any?> withEntityManager(block: EntityManager.() -> T): T fun <T : Any?> withEntityManager(block: EntityManager.() -> T): T

3
node/src/main/kotlin/net/corda/node/internal/AbstractNode.kt
View File

@ -1186,6 +1186,9 @@ abstract class AbstractNode<S>(val configuration: NodeConfiguration,
return flowManager.getFlowFactoryForInitiatingFlow(initiatingFlowClass) return flowManager.getFlowFactoryForInitiatingFlow(initiatingFlowClass)
} }
/**
* Exposes the database connection as a [RestrictedConnection] to the users.
*/
override fun jdbcSession(): Connection = RestrictedConnection(database.createSession()) override fun jdbcSession(): Connection = RestrictedConnection(database.createSession())
override fun <T : Any?> withEntityManager(block: EntityManager.() -> T): T { override fun <T : Any?> withEntityManager(block: EntityManager.() -> T): T {