@sitevision/api 2.0.0-alpha.1 → 2.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (332) hide show
  1. package/index.d.ts +8 -0
  2. package/package.json +1 -1
  3. package/server/AliasUtil/index.d.ts +13 -11
  4. package/server/ArchiveUtil/index.d.ts +45 -43
  5. package/server/ArraysInstance/index.d.ts +1667 -1808
  6. package/server/ArticleUtil/index.d.ts +294 -226
  7. package/server/AuthenticationUtil/index.d.ts +73 -85
  8. package/server/BookmarkUtil/index.d.ts +76 -81
  9. package/server/BuddyIconRenderer/index.d.ts +124 -132
  10. package/server/BuddyIconRenderer.BuddyIconSize/index.d.ts +41 -0
  11. package/server/BuddyIconRenderer.BuddyIconSize/index.js +25 -0
  12. package/server/ClientUtil/index.d.ts +11 -9
  13. package/server/CollaborationFactory/index.d.ts +37 -40
  14. package/server/CollaborationGroupFolderUtil/index.d.ts +30 -28
  15. package/server/CollaborationGroupState/index.d.ts +27 -0
  16. package/server/CollaborationGroupState/index.js +11 -0
  17. package/server/CollaborationGroupTemplateUtil/index.d.ts +48 -50
  18. package/server/CollaborationGroupType/index.d.ts +28 -0
  19. package/server/CollaborationGroupType/index.js +12 -0
  20. package/server/CollaborationGroupUtil/index.d.ts +86 -82
  21. package/server/CollectionsInstance/index.d.ts +642 -705
  22. package/server/ColorUtil/index.d.ts +36 -37
  23. package/server/CompoundAndFilterBuilder/index.d.ts +31 -29
  24. package/server/CompoundComparatorBuilder/index.d.ts +35 -33
  25. package/server/CompoundOrFilterBuilder/index.d.ts +31 -29
  26. package/server/ContentNodeUtil/index.d.ts +36 -34
  27. package/server/CurrencyFactory/index.d.ts +72 -70
  28. package/server/DateUtil/index.d.ts +132 -142
  29. package/server/DecorationUtil/index.d.ts +13 -11
  30. package/server/DeviceUtil/index.d.ts +21 -19
  31. package/server/DimensionMode/index.d.ts +17 -0
  32. package/server/DimensionMode/index.js +12 -0
  33. package/server/DirectoryUtil/index.d.ts +90 -88
  34. package/server/DocType/index.d.ts +30 -0
  35. package/server/DocType/index.js +14 -0
  36. package/server/DocTypeUtil/index.d.ts +129 -135
  37. package/server/EndecUtil/index.d.ts +330 -347
  38. package/server/ExtendedDismaxParserBuilder/index.d.ts +156 -170
  39. package/server/FileIconRenderer/index.d.ts +153 -172
  40. package/server/FileUtil/index.d.ts +274 -300
  41. package/server/FilterBuilder/index.d.ts +42 -40
  42. package/server/FolderUtil/index.d.ts +93 -94
  43. package/server/FontUtil/index.d.ts +36 -37
  44. package/server/FormatterBuilderFactory/index.d.ts +76 -84
  45. package/server/HighlightBuilder/index.d.ts +79 -86
  46. package/server/IconUtil/index.d.ts +27 -25
  47. package/server/ImageLinkRenderer/index.d.ts +34 -32
  48. package/server/ImageRenderer/index.d.ts +343 -379
  49. package/server/ImageUtil/index.d.ts +247 -265
  50. package/server/IndexUtil/index.d.ts +40 -37
  51. package/server/IndexUtil.IndexType/index.d.ts +29 -0
  52. package/server/IndexUtil.IndexType/index.js +13 -0
  53. package/server/IndexingUtil/index.d.ts +69 -47
  54. package/server/InstanceCreatorUtil/index.d.ts +421 -457
  55. package/server/InstanceTypeUtil/index.d.ts +168 -189
  56. package/server/JwtUtil/index.d.ts +131 -129
  57. package/server/LandingPageUtil/index.d.ts +84 -87
  58. package/server/LandingPageUtil/index.js +1 -0
  59. package/server/LinkPageUtil/index.d.ts +297 -251
  60. package/server/LinkRenderer/index.d.ts +651 -715
  61. package/server/LinkTargetBuilder/index.d.ts +69 -77
  62. package/server/LinkValueBuilder/index.d.ts +70 -77
  63. package/server/ListWrapper/index.d.ts +82 -91
  64. package/server/LocaleUtil/index.d.ts +382 -394
  65. package/server/LogUtil/index.d.ts +119 -128
  66. package/server/MailBuilder/index.d.ts +109 -124
  67. package/server/MailUtil/index.d.ts +58 -63
  68. package/server/MathInstance/index.d.ts +625 -657
  69. package/server/MessageDigesterFactory/index.d.ts +30 -28
  70. package/server/MetadataDefinitionUtil/index.d.ts +79 -83
  71. package/server/MetadataUtil/index.d.ts +322 -346
  72. package/server/MimeTypeUtil/index.d.ts +209 -215
  73. package/server/MonitorBuilder/index.d.ts +20 -20
  74. package/server/NodeComparatorUtil/index.d.ts +215 -225
  75. package/server/NodeFactoryUtil/index.d.ts +18 -16
  76. package/server/NodeFilterUtil/index.d.ts +652 -739
  77. package/server/NodeIteratorUtil/index.d.ts +214 -229
  78. package/server/NodeResolverUtil/index.d.ts +400 -406
  79. package/server/NodeTreeUtil/index.d.ts +214 -229
  80. package/server/NodeTypeUtil/index.d.ts +1432 -548
  81. package/server/OfflineVersionPropertyUtil/index.d.ts +8 -6
  82. package/server/OnlineVersionPropertyUtil/index.d.ts +8 -6
  83. package/server/OutputUtil/index.d.ts +385 -380
  84. package/server/PageUtil/index.d.ts +266 -188
  85. package/server/PermissionUtil/index.d.ts +393 -430
  86. package/server/PermissionUtil.Permission/index.d.ts +54 -0
  87. package/server/PermissionUtil.Permission/index.js +38 -0
  88. package/server/PortletContextUtil/index.d.ts +112 -107
  89. package/server/PortletUtil/index.d.ts +32 -22
  90. package/server/PrincipalUtil/index.d.ts +35 -33
  91. package/server/Properties/index.d.ts +69 -76
  92. package/server/PropertyUtil/index.d.ts +1422 -1464
  93. package/server/PublishingUtil/index.d.ts +248 -249
  94. package/server/QueryStringUtil/index.d.ts +404 -415
  95. package/server/RedirectUtil/index.d.ts +64 -68
  96. package/server/RelatedValueBuilder/index.d.ts +45 -43
  97. package/server/Requester/index.d.ts +125 -125
  98. package/server/ResourceLocatorUtil/index.d.ts +436 -476
  99. package/server/RestApi/index.d.ts +158 -138
  100. package/server/RestAppInvokerFactory/index.d.ts +28 -26
  101. package/server/RoleAssignmentBuilder/index.d.ts +39 -37
  102. package/server/RoleMatcherBuilder/index.d.ts +39 -37
  103. package/server/RoleUtil/index.d.ts +35 -37
  104. package/server/ScriptUtil/index.d.ts +458 -495
  105. package/server/SearchFactory/index.d.ts +90 -105
  106. package/server/SearchUtil/index.d.ts +75 -73
  107. package/server/SearcherBuilder/index.d.ts +117 -124
  108. package/server/Session/index.d.ts +261 -1103
  109. package/server/Session/index.js +1 -20
  110. package/server/SimpleUserUtil/index.d.ts +28 -29
  111. package/server/SiteCookieUtil/index.d.ts +152 -175
  112. package/server/SortBuilder/index.d.ts +27 -25
  113. package/server/SourceSetMode/index.d.ts +12 -0
  114. package/server/SourceSetMode/index.js +12 -0
  115. package/server/SpellCheckBuilder/index.d.ts +30 -30
  116. package/server/StandardParserBuilder/index.d.ts +36 -34
  117. package/server/StructureUtil/index.d.ts +85 -83
  118. package/server/SubscriberUtil/index.d.ts +60 -67
  119. package/server/SubscriptionUtil/index.d.ts +123 -130
  120. package/server/SystemUserUtil/index.d.ts +148 -146
  121. package/server/TagUtil/index.d.ts +115 -120
  122. package/server/TemplateUtil/index.d.ts +115 -120
  123. package/server/TemporaryFileNodeBuilder/index.d.ts +32 -30
  124. package/server/TemporaryNodeBuilder/index.d.ts +139 -177
  125. package/server/TextModuleRendererBuilder/index.d.ts +22 -20
  126. package/server/TimestampUtil/index.d.ts +103 -117
  127. package/server/TranslationUtil/index.d.ts +98 -104
  128. package/server/TrashcanUtil/index.d.ts +114 -117
  129. package/server/UserDataUtil/index.d.ts +110 -111
  130. package/server/UserFactory/index.d.ts +47 -54
  131. package/server/UserFieldRenderer/index.d.ts +120 -128
  132. package/server/UserIdentityUtil/index.d.ts +38 -36
  133. package/server/UserUtil/index.d.ts +32 -30
  134. package/server/Utils/index.d.ts +634 -723
  135. package/server/VelocityRenderer/index.d.ts +96 -94
  136. package/server/VersionUtil/index.d.ts +25 -9
  137. package/server/WebContentUtil/index.d.ts +277 -284
  138. package/server/WebResourceFactory/index.d.ts +41 -46
  139. package/server/XSLTUtil/index.d.ts +34 -32
  140. package/server/XmlParserUtil/index.d.ts +50 -48
  141. package/types/javax/jcr/Binary/index.d.ts +3 -21
  142. package/types/javax/jcr/Binary/index.js +0 -1
  143. package/types/javax/jcr/Credentials/index.d.ts +3 -1
  144. package/types/javax/jcr/ImportUUIDBehavior/index.d.ts +27 -1
  145. package/types/javax/jcr/Item/index.d.ts +6 -119
  146. package/types/javax/jcr/Item/index.js +0 -6
  147. package/types/javax/jcr/ItemVisitor/index.d.ts +5 -3
  148. package/types/javax/jcr/NamespaceRegistry/index.d.ts +69 -43
  149. package/types/javax/jcr/NamespaceRegistry/index.js +0 -2
  150. package/types/javax/jcr/Node/index.d.ts +37 -1506
  151. package/types/javax/jcr/Node/index.js +1 -34
  152. package/types/javax/jcr/NodeIterator/index.d.ts +5 -3
  153. package/types/javax/jcr/Property/index.d.ts +494 -494
  154. package/types/javax/jcr/Property/index.js +0 -5
  155. package/types/javax/jcr/PropertyIterator/index.d.ts +5 -3
  156. package/types/javax/jcr/RangeIterator/index.d.ts +2 -42
  157. package/types/javax/jcr/RangeIterator/index.js +1 -5
  158. package/types/javax/jcr/Repository/index.d.ts +465 -263
  159. package/types/javax/jcr/Repository/index.js +0 -4
  160. package/types/javax/jcr/RepositoryFactory/index.d.ts +4 -2
  161. package/types/javax/jcr/Value/index.d.ts +4 -31
  162. package/types/javax/jcr/Value/index.js +0 -2
  163. package/types/javax/jcr/ValueFactory/index.d.ts +6 -74
  164. package/types/javax/jcr/ValueFactory/index.js +1 -2
  165. package/types/javax/jcr/Workspace/index.d.ts +103 -577
  166. package/types/javax/jcr/Workspace/index.js +1 -12
  167. package/types/javax/jcr/lock/Lock/index.d.ts +4 -2
  168. package/types/javax/jcr/lock/LockManager/index.d.ts +4 -2
  169. package/types/javax/jcr/nodetype/ItemDefinition/index.d.ts +4 -105
  170. package/types/javax/jcr/nodetype/ItemDefinition/index.js +0 -5
  171. package/types/javax/jcr/nodetype/NodeDefinition/index.d.ts +5 -3
  172. package/types/javax/jcr/nodetype/NodeDefinitionTemplate/index.d.ts +4 -2
  173. package/types/javax/jcr/nodetype/NodeType/index.d.ts +262 -269
  174. package/types/javax/jcr/nodetype/NodeType/index.js +1 -12
  175. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.d.ts +5 -107
  176. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.js +1 -7
  177. package/types/javax/jcr/nodetype/NodeTypeIterator/index.d.ts +5 -3
  178. package/types/javax/jcr/nodetype/NodeTypeManager/index.d.ts +9 -130
  179. package/types/javax/jcr/nodetype/NodeTypeManager/index.js +1 -8
  180. package/types/javax/jcr/nodetype/NodeTypeTemplate/index.d.ts +4 -2
  181. package/types/javax/jcr/nodetype/PropertyDefinition/index.d.ts +5 -272
  182. package/types/javax/jcr/nodetype/PropertyDefinition/index.js +1 -7
  183. package/types/javax/jcr/nodetype/PropertyDefinitionTemplate/index.d.ts +5 -3
  184. package/types/javax/jcr/observation/Event/index.d.ts +85 -42
  185. package/types/javax/jcr/observation/EventIterator/index.d.ts +5 -3
  186. package/types/javax/jcr/observation/EventJournal/index.d.ts +4 -2
  187. package/types/javax/jcr/observation/EventListener/index.d.ts +4 -2
  188. package/types/javax/jcr/observation/EventListenerIterator/index.d.ts +5 -3
  189. package/types/javax/jcr/observation/ObservationManager/index.d.ts +6 -4
  190. package/types/javax/jcr/query/Query/index.d.ts +35 -12
  191. package/types/javax/jcr/query/QueryManager/index.d.ts +6 -4
  192. package/types/javax/jcr/query/QueryResult/index.d.ts +5 -3
  193. package/types/javax/jcr/query/Row/index.d.ts +5 -3
  194. package/types/javax/jcr/query/RowIterator/index.d.ts +5 -3
  195. package/types/javax/jcr/query/qom/And/index.d.ts +4 -2
  196. package/types/javax/jcr/query/qom/BindVariableValue/index.d.ts +4 -2
  197. package/types/javax/jcr/query/qom/ChildNode/index.d.ts +4 -2
  198. package/types/javax/jcr/query/qom/ChildNodeJoinCondition/index.d.ts +4 -2
  199. package/types/javax/jcr/query/qom/Column/index.d.ts +3 -1
  200. package/types/javax/jcr/query/qom/Comparison/index.d.ts +6 -4
  201. package/types/javax/jcr/query/qom/Constraint/index.d.ts +3 -1
  202. package/types/javax/jcr/query/qom/DescendantNode/index.d.ts +4 -2
  203. package/types/javax/jcr/query/qom/DescendantNodeJoinCondition/index.d.ts +4 -2
  204. package/types/javax/jcr/query/qom/DynamicOperand/index.d.ts +4 -2
  205. package/types/javax/jcr/query/qom/EquiJoinCondition/index.d.ts +4 -2
  206. package/types/javax/jcr/query/qom/FullTextSearch/index.d.ts +5 -3
  207. package/types/javax/jcr/query/qom/FullTextSearchScore/index.d.ts +4 -2
  208. package/types/javax/jcr/query/qom/Join/index.d.ts +5 -3
  209. package/types/javax/jcr/query/qom/JoinCondition/index.d.ts +3 -1
  210. package/types/javax/jcr/query/qom/Length/index.d.ts +5 -3
  211. package/types/javax/jcr/query/qom/Literal/index.d.ts +5 -3
  212. package/types/javax/jcr/query/qom/LowerCase/index.d.ts +4 -2
  213. package/types/javax/jcr/query/qom/NodeLocalName/index.d.ts +4 -2
  214. package/types/javax/jcr/query/qom/NodeName/index.d.ts +4 -2
  215. package/types/javax/jcr/query/qom/Not/index.d.ts +4 -2
  216. package/types/javax/jcr/query/qom/Operand/index.d.ts +3 -1
  217. package/types/javax/jcr/query/qom/Or/index.d.ts +4 -2
  218. package/types/javax/jcr/query/qom/Ordering/index.d.ts +4 -2
  219. package/types/javax/jcr/query/qom/PropertyExistence/index.d.ts +4 -2
  220. package/types/javax/jcr/query/qom/PropertyValue/index.d.ts +4 -2
  221. package/types/javax/jcr/query/qom/QueryObjectModel/index.d.ts +8 -6
  222. package/types/javax/jcr/query/qom/QueryObjectModelConstants/index.d.ts +76 -2
  223. package/types/javax/jcr/query/qom/QueryObjectModelFactory/index.d.ts +37 -35
  224. package/types/javax/jcr/query/qom/SameNode/index.d.ts +4 -2
  225. package/types/javax/jcr/query/qom/SameNodeJoinCondition/index.d.ts +4 -2
  226. package/types/javax/jcr/query/qom/Selector/index.d.ts +4 -2
  227. package/types/javax/jcr/query/qom/Source/index.d.ts +3 -1
  228. package/types/javax/jcr/query/qom/StaticOperand/index.d.ts +4 -2
  229. package/types/javax/jcr/query/qom/UpperCase/index.d.ts +4 -2
  230. package/types/javax/jcr/retention/Hold/index.d.ts +3 -1
  231. package/types/javax/jcr/retention/RetentionManager/index.d.ts +5 -3
  232. package/types/javax/jcr/retention/RetentionPolicy/index.d.ts +3 -1
  233. package/types/javax/jcr/security/AccessControlEntry/index.d.ts +4 -2
  234. package/types/javax/jcr/security/AccessControlList/index.d.ts +6 -4
  235. package/types/javax/jcr/security/AccessControlManager/index.d.ts +6 -4
  236. package/types/javax/jcr/security/AccessControlPolicy/index.d.ts +3 -1
  237. package/types/javax/jcr/security/AccessControlPolicyIterator/index.d.ts +5 -3
  238. package/types/javax/jcr/security/NamedAccessControlPolicy/index.d.ts +4 -2
  239. package/types/javax/jcr/security/Privilege/index.d.ts +130 -44
  240. package/types/javax/jcr/version/Version/index.d.ts +5 -3
  241. package/types/javax/jcr/version/VersionHistory/index.d.ts +7 -5
  242. package/types/javax/jcr/version/VersionIterator/index.d.ts +5 -3
  243. package/types/javax/jcr/version/VersionManager/index.d.ts +7 -5
  244. package/types/senselogic/sitevision/api/base/Builder/index.d.ts +3 -1
  245. package/types/senselogic/sitevision/api/base/Filter/index.d.ts +3 -1
  246. package/types/senselogic/sitevision/api/base/FilterSplit/index.d.ts +4 -2
  247. package/types/senselogic/sitevision/api/base/Loadable/index.d.ts +3 -1
  248. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.d.ts +9 -0
  249. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.js +11 -0
  250. package/types/senselogic/sitevision/api/base/Resolver/index.d.ts +3 -1
  251. package/types/senselogic/sitevision/api/base/Wrapper/index.d.ts +3 -1
  252. package/types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts +13 -7
  253. package/types/senselogic/sitevision/api/format/NumericFormatter/index.d.ts +3 -1
  254. package/types/senselogic/sitevision/api/format/NumericFormatterBuilder/index.d.ts +5 -3
  255. package/types/senselogic/sitevision/api/i18n/Currency/index.d.ts +3 -1
  256. package/types/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts +5 -3
  257. package/types/senselogic/sitevision/api/link/CustomLinkRenderData/index.d.ts +3 -1
  258. package/types/senselogic/sitevision/api/mail/Mail/index.d.ts +3 -1
  259. package/types/senselogic/sitevision/api/message/MessageTextLinker/index.d.ts +3 -1
  260. package/types/senselogic/sitevision/api/metadata/value/LinkValue/index.d.ts +3 -1
  261. package/types/senselogic/sitevision/api/metadata/value/RelatedValue/index.d.ts +3 -1
  262. package/types/senselogic/sitevision/api/property/VersionedPropertyUtil/index.d.ts +4 -2
  263. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.d.ts +51 -0
  264. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.js +12 -0
  265. package/types/senselogic/sitevision/api/render/ImageScaler/index.d.ts +4 -2
  266. package/types/senselogic/sitevision/api/render/TextModuleRenderer/index.d.ts +4 -2
  267. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess/index.d.ts +3 -1
  268. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.d.ts +85 -0
  269. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.js +21 -0
  270. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.d.ts +31 -0
  271. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.js +12 -0
  272. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.d.ts +31 -0
  273. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.js +12 -0
  274. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.d.ts +67 -0
  275. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.js +18 -0
  276. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.d.ts +25 -0
  277. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.js +11 -0
  278. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.d.ts +19 -0
  279. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.js +10 -0
  280. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts +1243 -0
  281. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js +189 -0
  282. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.d.ts +31 -0
  283. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.js +12 -0
  284. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.d.ts +91 -0
  285. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.js +22 -0
  286. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.d.ts +27 -0
  287. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.js +11 -0
  288. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.d.ts +19 -0
  289. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.js +10 -0
  290. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.d.ts +19 -0
  291. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.js +10 -0
  292. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.d.ts +25 -0
  293. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.js +11 -0
  294. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.d.ts +37 -0
  295. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.js +13 -0
  296. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.d.ts +25 -0
  297. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.js +11 -0
  298. package/types/senselogic/sitevision/api/render/velocity/VelocityContext/index.d.ts +3 -1
  299. package/types/senselogic/sitevision/api/render/velocity/VelocityEvaluator/index.d.ts +3 -1
  300. package/types/senselogic/sitevision/api/script/RequesterChainable/index.d.ts +4 -2
  301. package/types/senselogic/sitevision/api/script/app/RestAppInvoker/index.d.ts +3 -1
  302. package/types/senselogic/sitevision/api/script/factory/TypedArgument/index.d.ts +3 -1
  303. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.d.ts +3 -1
  304. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts +4 -2
  305. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts +24 -2
  306. package/types/senselogic/sitevision/api/search/SearchFieldUtil/index.d.ts +3 -1
  307. package/types/senselogic/sitevision/api/search/SearchHighlighter/index.d.ts +4 -2
  308. package/types/senselogic/sitevision/api/search/SearchHit/index.d.ts +19 -3
  309. package/types/senselogic/sitevision/api/search/SearchResult/index.d.ts +31 -7
  310. package/types/senselogic/sitevision/api/search/facet/SearchFacetField/index.d.ts +3 -1
  311. package/types/senselogic/sitevision/api/search/facet/SearchFacetValue/index.d.ts +3 -1
  312. package/types/senselogic/sitevision/api/search/searcher/Searcher/index.d.ts +4 -2
  313. package/types/senselogic/sitevision/api/search/searcher/component/Filter/index.d.ts +3 -1
  314. package/types/senselogic/sitevision/api/search/searcher/component/Highlight/index.d.ts +3 -1
  315. package/types/senselogic/sitevision/api/search/searcher/component/Monitor/index.d.ts +3 -1
  316. package/types/senselogic/sitevision/api/search/searcher/component/Parser/index.d.ts +3 -1
  317. package/types/senselogic/sitevision/api/search/searcher/component/Sort/index.d.ts +3 -1
  318. package/types/senselogic/sitevision/api/search/searcher/component/SpellCheck/index.d.ts +3 -1
  319. package/types/senselogic/sitevision/api/search/sort/CustomSort/index.d.ts +3 -1
  320. package/types/senselogic/sitevision/api/search/suggestion/SearchSuggestion/index.d.ts +3 -1
  321. package/types/senselogic/sitevision/api/security/DirectoryAttributes/index.d.ts +3 -1
  322. package/types/senselogic/sitevision/api/security/MessageDigester/index.d.ts +3 -1
  323. package/types/senselogic/sitevision/api/security/RoleAssignment/index.d.ts +4 -2
  324. package/types/senselogic/sitevision/api/security/RoleMatcher/index.d.ts +4 -2
  325. package/types/senselogic/sitevision/api/security/SecretStore/index.d.ts +3 -1
  326. package/types/senselogic/sitevision/api/security/UserUtil/index.d.ts +4 -2
  327. package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts +35 -3
  328. package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilterChain/index.d.ts +3 -1
  329. package/types/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts +5 -3
  330. package/types/senselogic/sitevision/api/webresource/LinkTarget/index.d.ts +3 -1
  331. package/types/senselogic/sitevision/api/xml/XmlElement/index.d.ts +3 -1
  332. package/types/senselogic/sitevision/api/xml/XmlElementHandler/index.d.ts +4 -2
@@ -1,1046 +1,15 @@
1
- import type { Repository } from "../../types/javax/jcr/Repository";
1
+ import type Repository from "../../types/javax/jcr/Repository";
2
2
 
3
- import type { Workspace } from "../../types/javax/jcr/Workspace";
4
- import type { Node } from "../../types/javax/jcr/Node";
5
- import type { Credentials } from "../../types/javax/jcr/Credentials";
6
- import type { Item } from "../../types/javax/jcr/Item";
7
- import type { Property } from "../../types/javax/jcr/Property";
3
+ import type Workspace from "../../types/javax/jcr/Workspace";
4
+ import type Node from "../../types/javax/jcr/Node";
5
+ import type Credentials from "../../types/javax/jcr/Credentials";
6
+ import type Item from "../../types/javax/jcr/Item";
7
+ import type Property from "../../types/javax/jcr/Property";
8
8
 
9
- import type { ValueFactory } from "../../types/javax/jcr/ValueFactory";
9
+ import type ValueFactory from "../../types/javax/jcr/ValueFactory";
10
10
 
11
- import type { AccessControlManager } from "../../types/javax/jcr/security/AccessControlManager";
12
- import type { RetentionManager } from "../../types/javax/jcr/retention/RetentionManager";
13
-
14
- /**
15
- * Returns the <code>Repository</code> object through which this session was
16
- * acquired.
17
- * @return a <code>{@link Repository}</code> object.
18
- */
19
- export function getRepository(): Repository;
20
-
21
- /**
22
- * Gets the user ID associated with this <code>Session</code>. How the user
23
- * ID is set is up to the implementation, it may be a string passed in as
24
- * part of the credentials or it may be a string acquired in some other way.
25
- * This method is free to return an "anonymous user ID" or
26
- * <code>null</code>.
27
- * @return the user ID associated with this <code>Session</code>.
28
- */
29
- export function getUserID(): string;
30
-
31
- /**
32
- * Returns the names of the attributes set in this session as a result of
33
- * the <code>Credentials</code> that were used to acquire it. Not all
34
- * <code>Credentials</code> implementations will contain attributes (though,
35
- * for example, <code>SimpleCredentials</code> does allow for them). This
36
- * method returns an empty array if the <code>Credentials</code> instance
37
- * did not provide attributes.
38
- * @return A string array containing the names of all attributes passed in the credentials used to acquire this session.
39
- */
40
- export function getAttributeNames(): string;
41
-
42
- /**
43
- * Returns the value of the named attribute as an <code>Object</code>, or
44
- * <code>null</code> if no attribute of the given name exists. See {@link
45
- * Session#getAttributeNames}.
46
- * @param name the name of an attribute passed in the credentials used to acquire this session.
47
- * @return the value of the attribute or <code>null</code> if no attribute of the given name exists.
48
- */
49
- export function getAttribute(name: string): unknown;
50
-
51
- /**
52
- * Returns the <code>Workspace</code> attached to this
53
- * <code>Session</code>.
54
- * @return a <code>{@link Workspace}</code> object.
55
- */
56
- export function getWorkspace(): Workspace;
57
-
58
- /**
59
- * Returns the root node of the workspace, "/". This node is the main access
60
- * point to the content of the workspace.
61
- * @return The root node of the workspace: a <code>{@link Node}</code> object.
62
- * @throws RepositoryException if an error occurs.
63
- */
64
- export function getRootNode(): Node;
65
-
66
- /**
67
- * Returns a new session in accordance with the specified (new) Credentials.
68
- * Allows the current user to "impersonate" another using incomplete or
69
- * relaxed credentials requirements (perhaps including a user name but no
70
- * password, for example), assuming that this <code>Session</code> gives
71
- * them that permission.
72
- * <p>
73
- * The new <code>Session</code> is tied to a new <code>Workspace</code>
74
- * instance. In other words, <code>Workspace</code> instances are not
75
- * re-used. However, the <code>Workspace</code> instance returned represents
76
- * the same actual persistent workspace entity in the repository as is
77
- * represented by the <code>Workspace</code> object tied to this
78
- * <code>Session</code>.
79
- * @param credentials A <code>Credentials</code> object
80
- * @return a <code>Session</code> object
81
- * @throws LoginException if the current session does not have sufficient access to perform the operation.
82
- * @throws RepositoryException if another error occurs.
83
- */
84
- export function impersonate(credentials: Credentials): Session;
85
-
86
- /**
87
- * Returns the node specified by the given UUID. Only applies to nodes that
88
- * expose a UUID, in other words, those of mixin node type
89
- * <code>mix:referenceable</code>
90
- *
91
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
92
- * @param uuid A universally unique identifier.
93
- * @return A <code>Node</code>.
94
- * @throws ItemNotFoundException if the specified UUID is not found.
95
- * @throws RepositoryException if another error occurs.
96
- * @deprecated As of JCR 2.0, {@link #getNodeByIdentifier(String)} should be used instead.
97
- */
98
- export function getNodeByUUID(uuid: string): Node;
99
-
100
- /**
101
- * Returns the node specified by the given identifier. Applies to both
102
- * referenceable and non-referenceable nodes.
103
- * @param id An identifier.
104
- * @return A <code>Node</code>.
105
- * @throws ItemNotFoundException if no node with the specified identifier exists or if this <code>Session</code> does not have read access to the node with the specified identifier.
106
- * @throws RepositoryException if another error occurs.
107
- * @since JCR 2.0
108
- */
109
- export function getNodeByIdentifier(id: string): Node;
110
-
111
- /**
112
- * Returns the node at the specified absolute path in the workspace. If no
113
- * such node exists, then it returns the property at the specified path.
114
- * <p>
115
- * This method should only be used if the application does not know whether
116
- * the item at the indicated path is property or node. In cases where the
117
- * application has this information, either {@link #getNode} or {@link
118
- * #getProperty} should be used, as appropriate. In many repository
119
- * implementations the node and property-specific methods are likely to be
120
- * more efficient than <code>getItem</code>.
121
- * @param absPath An absolute path.
122
- * @return the specified <code>Item</code>.
123
- * @throws PathNotFoundException if no accessible item is found at the specified path.
124
- * @throws RepositoryException if another error occurs.
125
- */
126
- export function getItem(absPath: string): Item;
127
-
128
- /**
129
- * Returns the node at the specified absolute path in the workspace.
130
- * @param absPath An absolute path.
131
- * @return the specified <code>Node</code>.
132
- * @throws PathNotFoundException If no accessible node is found at the specifed path.
133
- * @throws RepositoryException If another error occurs.
134
- * @since JCR 2.0
135
- */
136
- export function getNode(absPath: string): Node;
137
-
138
- /**
139
- * Returns the property at the specified absolute path in the workspace.
140
- * @param absPath An absolute path.
141
- * @return the specified <code>Property</code>.
142
- * @throws PathNotFoundException If no accessible property is found at the specified path.
143
- * @throws RepositoryException if another error occurs.
144
- * @since JCR 2.0
145
- */
146
- export function getProperty(absPath: string): Property;
147
-
148
- /**
149
- * Returns <code>true</code> if an item exists at <code>absPath</code> and
150
- * this <code>Session</code> has read access to it; otherwise returns
151
- * <code>false</code>.
152
- * @param absPath An absolute path.
153
- * @return a <code>boolean</code>
154
- * @throws RepositoryException if <code>absPath</code> is not a well-formed absolute path.
155
- */
156
- export function itemExists(absPath: string): boolean;
157
-
158
- /**
159
- * Returns <code>true</code> if a node exists at <code>absPath</code> and
160
- * this <code>Session</code> has read access to it; otherwise returns
161
- * <code>false</code>.
162
- * @param absPath An absolute path.
163
- * @return a <code>boolean</code>
164
- * @throws RepositoryException if <code>absPath</code> is not a well-formed absolute path.
165
- * @since JCR 2.0
166
- */
167
- export function nodeExists(absPath: string): boolean;
168
-
169
- /**
170
- * Returns <code>true</code> if a property exists at <code>absPath</code>
171
- * and this <code>Session</code> has read access to it; otherwise returns
172
- * <code>false</code>.
173
- * @param absPath An absolute path.
174
- * @return a <code>boolean</code>
175
- * @throws RepositoryException if <code>absPath</code> is not a well-formed absolute path.
176
- * @since JCR 2.0
177
- */
178
- export function propertyExists(absPath: string): boolean;
179
-
180
- /**
181
- * Moves the node at <code>srcAbsPath</code> (and its entire subgraph) to
182
- * the new location at <code>destAbsPath</code>.
183
- * <p>
184
- * This is a session-write method and therefor requires a <code>save</code>
185
- * to dispatch the change.
186
- * <p>
187
- * The identifiers of referenceable nodes <i>must not</i> be changed by a
188
- * <code>move</code>. The identifiers of non-referenceable nodes <i>may</i>
189
- * change.
190
- * <p>
191
- * A <code>ConstraintViolationException</code> is thrown either immediately,
192
- * on dispatch or on persist, if performing this operation would violate a
193
- * node type or implementation-specific constraint. Implementations may
194
- * differ on when this validation is performed.
195
- * <p>
196
- * As well, a <code>ConstraintViolationException</code> will be thrown on
197
- * persist if an attempt is made to separately <code>save</code> either the
198
- * source or destination node.
199
- * <p>
200
- * Note that this behavior differs from that of {@link Workspace#move},
201
- * which is a workspace-write method and therefore immediately dispatches
202
- * changes.
203
- * <p>
204
- * The <code>destAbsPath</code> provided must not have an index on its final
205
- * element. If ordering is supported by the node type of the parent node of
206
- * the new location, then the newly moved node is appended to the end of the
207
- * child node list.
208
- * <p>
209
- * This method cannot be used to move an individual property by itself. It
210
- * moves an entire node and its subgraph.
211
- * <p>
212
- * If no node exists at <code>srcAbsPath</code> or no node exists one level
213
- * above <code>destAbsPath</code> (in other words, there is no node that
214
- * will serve as the parent of the moved item) then a
215
- * <code>PathNotFoundException</code> is thrown either immediately, on
216
- * dispatch or on persist. Implementations may differ on when this
217
- * validation is performed.
218
- * <p>
219
- * An <code>ItemExistsException</code> is thrown either immediately, on
220
- * dispatch or on persist, if a node already exists at
221
- * <code>destAbsPath</code> and same-name siblings are not allowed.
222
- * Implementations may differ on when this validation is performed.
223
- * <p>
224
- * Note that if a property already exists at <code>destAbsPath</code>, the
225
- * operation succeeds, since a node may have a child node and property with
226
- * the same name.
227
- * <p>
228
- * A <code>VersionException</code> is thrown either immediately, on dispatch
229
- * or on persist, if the parent node of <code>destAbsPath</code> or the
230
- * parent node of <code>srcAbsPath</code> is read-only due to a checked-in node.
231
- * Implementations may differ on when this validation is performed.
232
- * <p>
233
- * A <code>LockException</code> is thrown either immediately, on dispatch or
234
- * on persist, if a lock prevents the <code>move</code>. Implementations may
235
- * differ on when this validation is performed.
236
- *
237
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
238
- * @param srcAbsPath the root of the subgraph to be moved.
239
- * @param destAbsPath the location to which the subgraph is to be moved.
240
- * @throws ItemExistsException if a node already exists at <code>destAbsPath</code> and same-name siblings are not allowed.
241
- * @throws PathNotFoundException if either <code>srcAbsPath</code> or <code>destAbsPath</code> cannot be found and this implementation performs this validation immediately.
242
- * @throws VersionException if the parent node of <code>destAbsPath</code> or the parent node of <code>srcAbsPath</code> is versionable and checked-in, or or is non-versionable and its nearest versionable ancestor is checked-in and this implementation performs this validation immediately.
243
- * @throws ConstraintViolationException if a node-type or other constraint violation is detected immediately and this implementation performs this validation immediately.
244
- * @throws LockException if the move operation would violate a lock and this implementation performs this validation immediately.
245
- * @throws RepositoryException if the last element of <code>destAbsPath</code> has an index or if another error occurs.
246
- */
247
- export function move(srcAbsPath: string, destAbsPath: string): void;
248
-
249
- /**
250
- * Removes the specified item and its subgraph.
251
- * <p>
252
- * This is a session-write method and therefore requires a <code>save</code>
253
- * in order to dispatch the change.
254
- * <p>
255
- * If a node with same-name siblings is removed, this decrements by one the
256
- * indices of all the siblings with indices greater than that of the removed
257
- * node. In other words, a removal compacts the array of same-name siblings
258
- * and causes the minimal re-numbering required to maintain the original
259
- * order but leave no gaps in the numbering.
260
- * <p>
261
- * A <code>ReferentialIntegrityException</code> will be thrown on dispatch
262
- * if the specified item or an item in its subgraph is currently the target
263
- * of a <code>REFERENCE</code> property located in this workspace but
264
- * outside the specified item's subgraph and the current
265
- * <code>Session</code> has read access to that <code>REFERENCE</code>
266
- * property.
267
- * <p>
268
- * A <code>ConstraintViolationException</code> will be thrown either
269
- * immediately, on dispatch or on persist, if removing the specified item
270
- * would violate a node type or implementation-specific constraint.
271
- * Implementations may differ on when this validation is performed.
272
- * <p>
273
- * A <code>VersionException</code> will be thrown either immediately, on
274
- * dispatch or on persist, if the parent node of the specified item is
275
- * read-only due to a checked-in node. Implementations may differ on when
276
- * this validation is performed.
277
- * <p>
278
- * A <code>LockException</code> will be thrown either immediately, on
279
- * dispatch or on persist, if a lock prevents the removal of the specified
280
- * item. Implementations may differ on when this validation is performed.
281
- * <p>
282
- * A <code>PathNotFoundException</code> will be thrown either immediately,
283
- * on dispatch or on persist, if no accessible item is found at at
284
- * <code>absPath</code>.
285
- * <p>
286
- * A <code>AccessDeniedException</code> will be thrown either immediately,
287
- * on dispatch or on persist, if the specified item or an item in its
288
- * subgraph is currently the target of a <code>REFERENCE</code> property
289
- * located in this workspace but outside the specified item's subgraph and
290
- * the current <code>Session</code> <i>does not</i> have read access to that
291
- * <code>REFERENCE</code> property.
292
- *
293
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
294
- * @param absPath the absolute path of the item to be removed.
295
- * @throws VersionException if the parent node of the item at absPath is read-only due to a checked-in node and this implementation performs this validation immediately.
296
- * @throws LockException if a lock prevents the removal of the specified item and this implementation performs this validation immediately.
297
- * @throws ConstraintViolationException if removing the specified item would violate a node type or implementation-specific constraint and this implementation performs this validation immediately.
298
- * @throws PathNotFoundException if no accessible item is found at <code>absPath</code> and this implementation performs this validation immediately.
299
- * @throws AccessDeniedException if the specified item or an item in its subgraph is currently the target of a <code>REFERENCE</code> property located in this workspace but outside the specified item's subgraph and the current <code>Session</code> <i>does not</i> have read access to that <code>REFERENCE</code> property and this implementation performs this validation immediately.
300
- * @throws RepositoryException if another error occurs.
301
- * @see Item#remove()
302
- * @since JCR 2.0
303
- */
304
- export function removeItem(absPath: string): void;
305
-
306
- /**
307
- * Validates all pending changes currently recorded in this
308
- * <code>Session</code>. If validation of <i>all</i> pending changes
309
- * succeeds, then this change information is cleared from the
310
- * <code>Session</code>.
311
- * <p>
312
- * If the <code>save</code> occurs outside a transaction, the changes are
313
- * <i>dispatched</i> and <i>persisted</i>. Upon being persisted the changes
314
- * become potentially visible to other <code>Sessions</code> bound to the
315
- * same persitent workspace.
316
- * <p>
317
- * If the <code>save</code> occurs within a transaction, the changes are
318
- * <i>dispatched</i> but are not <i>persisted</i> until the transaction is
319
- * committed.
320
- * <p>
321
- * If validation fails, then no pending changes are dispatched and they
322
- * remain recorded on the <code>Session</code>. There is no best-effort or
323
- * partial <code>save</code>.
324
- *
325
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
326
- * @throws AccessDeniedException if any of the changes to be persisted would violate the access privileges of the this <code>Session</code>. Also thrown if any of the changes to be persisted would cause the removal of a node that is currently referenced by a <code>REFERENCE</code> property that this Session <i>does not</i> have read access to.
327
- * @throws ItemExistsException if any of the changes to be persisted would be prevented by the presence of an already existing item in the workspace.
328
- * @throws ConstraintViolationException if any of the changes to be persisted would violate a node type or restriction. Additionally, a repository may use this exception to enforce implementation- or configuration-dependent restrictions.
329
- * @throws InvalidItemStateException if any of the changes to be persisted conflicts with a change already persisted through another session and the implementation is such that this conflict can only be detected at <code>save</code>-time and therefore was not detected earlier, at change-time.
330
- * @throws ReferentialIntegrityException if any of the changes to be persisted would cause the removal of a node that is currently referenced by a <code>REFERENCE</code> property that this <code>Session</code> has read access to.
331
- * @throws VersionException if the <code>save</code> would make a result in a change to persistent storage that would violate the read-only status of a checked-in node.
332
- * @throws LockException if the <code>save</code> would result in a change to persistent storage that would violate a lock.
333
- * @throws NoSuchNodeTypeException if the <code>save</code> would result in the addition of a node with an unrecognized node type.
334
- * @throws RepositoryException if another error occurs.
335
- */
336
- export function save(): void;
337
-
338
- /**
339
- * If <code>keepChanges</code> is <code>false</code>, this method discards
340
- * all pending changes currently recorded in this <code>Session</code> and
341
- * returns all items to reflect the current saved state. Outside a
342
- * transaction this state is simply the current state of persistent storage.
343
- * Within a transaction, this state will reflect persistent storage as
344
- * modified by changes that have been saved but not yet committed.
345
- * <p>
346
- * If <code>keepChanges</code> is true then pending change are not discarded
347
- * but items that do not have changes pending have their state refreshed to
348
- * reflect the current saved state, thus revealing changes made by other
349
- * sessions.
350
- *
351
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
352
- * @param keepChanges a boolean
353
- * @throws RepositoryException if an error occurs.
354
- */
355
- export function refresh(keepChanges: boolean): void;
356
-
357
- /**
358
- * Returns <code>true</code> if this session holds pending (that is,
359
- * unsaved) changes; otherwise returns <code>false</code>.
360
- *
361
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
362
- * @return a boolean
363
- * @throws RepositoryException if an error occurs
364
- */
365
- export function hasPendingChanges(): boolean;
366
-
367
- /**
368
- * This method returns a <code>ValueFactory</code> that is used to create
369
- * <code>Value</code> objects for use when setting repository properties.
370
- * @since Sitevision 3.0
371
- * @return a <code>ValueFactory</code>
372
- * @throws UnsupportedRepositoryOperationException if writing to the repository is not supported.
373
- * @throws RepositoryException if another error occurs.
374
- */
375
- export function getValueFactory(): ValueFactory;
376
-
377
- /**
378
- * Returns <code>true</code> if this <code>Session</code> has permission to
379
- * perform the specified actions at the specified <code>absPath</code> and
380
- * <code>false</code> otherwise.
381
- * <p>
382
- * The <code>actions</code> parameter is a comma separated list of action
383
- * strings. The following action strings are defined: <ul> <li> {@link
384
- * #ACTION_ADD_NODE add_node}: If <code>hasPermission(path,
385
- * "add_node")</code> returns <code>true</code>, then this
386
- * <code>Session</code> has permission to add a node at <code>path</code>.
387
- * </li> <li> {@link #ACTION_SET_PROPERTY set_property}: If
388
- * <code>hasPermission(path, "set_property")</code> returns
389
- * <code>true</code>, then this <code>Session</code> has permission to set
390
- * (add or change) a property at <code>path</code>. </li> <li> {@link
391
- * #ACTION_REMOVE remove}: If <code>hasPermission(path,
392
- * "remove")</code> returns <code>true</code>, then this
393
- * <code>Session</code> has permission to remove an item at
394
- * <code>path</code>. </li> <li> {@link #ACTION_READ read}: If
395
- * <code>hasPermission(path, "read")</code> returns <code>true</code>, then
396
- * this <code>Session</code> has permission to retrieve (and read the value
397
- * of, in the case of a property) an item at <code>path</code>. </li> </ul>
398
- * When more than one action is specified in the <code>actions</code>
399
- * parameter, this method will only return <code>true</code> if this
400
- * <code>Session</code> has permission to perform <i>all</i> of the listed
401
- * actions at the specified path.
402
- * <p>
403
- * The information returned through this method will only reflect the access
404
- * control status (both JCR defined and implementation-specific) and not
405
- * other restrictions that may exist, such as node type constraints. For
406
- * example, even though <code>hasPermission</code> may indicate that a
407
- * particular <code>Session</code> may add a property at
408
- * <code>/A/B/C</code>, the node type of the node at <code>/A/B</code> may
409
- * prevent the addition of a property called <code>C</code>.
410
- *
411
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
412
- * @param absPath an absolute path.
413
- * @param actions a comma separated list of action strings.
414
- * @return <code>true</code> if this <code>Session</code> has permission to perform the specified actions at the specified <code>absPath</code>.
415
- * @throws RepositoryException if an error occurs.
416
- * @since JCR 2.0
417
- */
418
- export function hasPermission(absPath: string, actions: string): boolean;
419
-
420
- /**
421
- * Determines whether this <code>Session</code> has permission to perform
422
- * the specified actions at the specified <code>absPath</code>. This method
423
- * quietly returns if the access request is permitted, or throws a suitable
424
- * <code>java.security.AccessControlException</code> otherwise.
425
- * <p>
426
- * The <code>actions</code> parameter is a comma separated list of action
427
- * strings. The following action strings are defined: <ul> <li> {@link
428
- * #ACTION_ADD_NODE add_node}: If <code>checkPermission(path,
429
- * "add_node")</code> returns quietly, then this <code>Session</code> has
430
- * permission to add a node at <code>path</code>, otherwise permission is
431
- * denied. </li> <li> {@link #ACTION_SET_PROPERTY set_property}:
432
- * If <code>checkPermission(path, "set_property")</code> returns quietly,
433
- * then this <code>Session</code> has permission to set (add or change) a
434
- * property at <code>path</code>, otherwise permission is denied. </li> <li>
435
- * {@link #ACTION_REMOVE remove}: If <code>checkPermission(path,
436
- * "remove")</code> returns quietly, then this <code>Session</code> has
437
- * permission to remove an item at <code>path</code>, otherwise permission
438
- * is denied. </li> <li> {@link #ACTION_READ read}: If
439
- * <code>checkPermission(path, "read")</code> returns quietly, then this
440
- * <code>Session</code> has permission to retrieve (and read the value of,
441
- * in the case of a property) an item at <code>path</code>, otherwise
442
- * permission is denied. </li> </ul> When more than one action is specified
443
- * in the <code>actions</code> parameter, this method will only return
444
- * quietly if this <code>Session</code> has permission to perform <i>all</i>
445
- * of the listed actions at the specified path.
446
- * <p>
447
- * The information returned through this method will only reflect access
448
- * control status (both JCR defined and implementation-specific) and not
449
- * other restrictions that may exist, such as node type constraints. For
450
- * example, even though <code>checkPermission</code> may indicate that a
451
- * particular <code>Session</code> may add a property at
452
- * <code>/A/B/C</code>, the node type of the node at <code>/A/B</code> may
453
- * prevent the addition of a property called <code>C</code>.
454
- *
455
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
456
- * @param absPath an absolute path.
457
- * @param actions a comma separated list of action strings.
458
- * @throws java.security.AccessControlException If permission is denied.
459
- * @throws RepositoryException if another error occurs.
460
- */
461
- export function checkPermission(absPath: string, actions: string): void;
462
-
463
- /**
464
- * Checks whether an operation can be performed given as much context as can
465
- * be determined by the repository, including: <ul> <li> Permissions granted
466
- * to the current user, including access control privileges. </li> <li>
467
- * Current state of the target object (reflecting locks, checkin/checkout
468
- * status, retention and hold status etc.). </li> <li> Repository
469
- * capabilities. </li> <li> Node type-enforced restrictions. </li> <li>
470
- * Repository configuration-specific restrictions. </li> </ul> The
471
- * implementation of this method is best effort: returning
472
- * <code>false</code> guarantees that the operation cannot be performed, but
473
- * returning <code>true</code> does not guarantee the opposite. The
474
- * repository implementation should use this to give priority to performance
475
- * over completeness. An exception should be thrown only for important
476
- * failures such as loss of connectivity to the back-end.
477
- * <p>
478
- * The implementation of this method is best effort: returning false
479
- * guarantees that the operation cannot be performed, but returning true
480
- * does not guarantee the opposite.
481
- * <p>
482
- * The <code>methodName</code> parameter identifies the method in question
483
- * by its name as defined in the Javadoc.
484
- * <p>
485
- * The <code>target</code> parameter identifies the object on which the
486
- * specified method is called.
487
- * <p>
488
- * The <code>arguments</code> parameter contains an array of type
489
- * <code>Object</code> object consisting of the arguments to be passed
490
- * to the method in question. In cases where a parameter is a Java
491
- * primitive type it must be converted to its corresponding Java object form.
492
- * <p>
493
- * For example, given a <code>Session</code> <code>S</code> and
494
- * <code>Node</code> <code>N</code> then
495
- * <p>
496
- * <code>boolean b = S.hasCapability("addNode", N, new Object[]{"foo"});</code>
497
- * <p>
498
- * will result in <code>b == false</code> if a child node called <code>foo</code> cannot be added to
499
- * the node <code>N</code> within the session <code>S</code>.
500
- *
501
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
502
- * @param methodName the nakme of the method.
503
- * @param target the target object of the operation.
504
- * @param arguments the arguments of the operation.
505
- * @return <code>false</code> if the operation cannot be performed, <code>true</code> if the operation can be performed or if the repository cannot determine whether the operation can be performed.
506
- * @throws RepositoryException if an error occurs
507
- * @since JCR 2.0
508
- */
509
- export function hasCapability(
510
- methodName: string,
511
- target: unknown,
512
- arguments: unknown
513
- ): boolean;
514
-
515
- /**
516
- * Returns an <code>org.xml.sax.ContentHandler</code> which is used to push
517
- * SAX events to the repository. If the incoming XML (in the form of SAX
518
- * events) does not appear to be a JCR <i>system view</i> XML document then
519
- * it is interpreted as a JCR <i>document view</i> XML document.
520
- * <p>
521
- * The incoming XML is deserialized into a subgraph of items immediately
522
- * below the node at <code>parentAbsPath</code>.
523
- * <p>
524
- * This method simply returns the <code>ContentHandler</code> without
525
- * altering the state of the session; the actual deserialization to the
526
- * session transient space is done through the methods of the
527
- * <code>ContentHandler</code>. Invalid XML data will cause the
528
- * <code>ContentHandler</code> to throw a <code>SAXException</code>.
529
- * <p>
530
- * As SAX events are fed into the <code>ContentHandler</code>, the tree of
531
- * new items is built in the transient storage of the session. In order to
532
- * dispatch the new content, <code>save</code> must be called. See {@link
533
- * Workspace#getImportContentHandler} for a workspace-write version of this
534
- * method.
535
- * <p>
536
- * The flag <code>uuidBehavior</code> governs how the identifiers of
537
- * incoming nodes are handled: <ul> <li> {@link ImportUUIDBehavior#IMPORT_UUID_CREATE_NEW}:
538
- * Incoming identifiers nodes are added in the same way that new node is
539
- * added with <code>Node.addNode</code>. That is, they are either assigned
540
- * newly created identifiers upon addition or upon <code>save</code>
541
- * (depending on the implementation). In either case, identifier collisions
542
- * will not occur. </li> <li> {@link ImportUUIDBehavior#IMPORT_UUID_COLLISION_REMOVE_EXISTING}:
543
- * If an incoming node has the same identifier as a node already existing in
544
- * the workspace then the already existing node (and its subgraph) is
545
- * removed from wherever it may be in the workspace before the incoming node
546
- * is added. Note that this can result in nodes "disappearing" from
547
- * locations in the workspace that are remote from the location to which the
548
- * incoming subgraph is being written. Both the removal and the new addition
549
- * will be persisted on <code>save</code>. </li> <li> {@link
550
- * ImportUUIDBehavior#IMPORT_UUID_COLLISION_REPLACE_EXISTING}: If an
551
- * incoming node has the same identifier as a node already existing in the
552
- * workspace, then the already-existing node is replaced by the incoming
553
- * node in the same position as the existing node. Note that this may result
554
- * in the incoming subgraph being disaggregated and "spread around" to
555
- * different locations in the workspace. In the most extreme case this
556
- * behavior may result in no node at all being added as child of
557
- * <code>parentAbsPath</code>. This will occur if the topmost element of the
558
- * incoming XML has the same identifier as an existing node elsewhere in the
559
- * workspace. The change will be persisted on <code>save</code>. </li> <li>
560
- * {@link ImportUUIDBehavior#IMPORT_UUID_COLLISION_THROW}: If an incoming
561
- * node has the same identifier as a node already existing in the workspace
562
- * then a <code>SAXException</code> is thrown by the
563
- * <code>ContentHandler</code> during deserialization. </li> </ul> Unlike
564
- * <code>Workspace.getImportContentHandler</code>, this method does not
565
- * necessarily enforce all node type constraints during deserialization.
566
- * Those that would be immediately enforced in a session-write method
567
- * (<code>Node.addNode</code>, <code>Node.setProperty</code> etc.) of this
568
- * implementation cause the returned <code>ContentHandler</code> to throw an
569
- * immediate <code>SAXException</code> during deserialization. All other
570
- * constraints are checked on save, just as they are in normal write
571
- * operations. However, which node type constraints are enforced depends
572
- * upon whether node type information in the imported data is respected, and
573
- * this is an implementation-specific issue.
574
- * <p>
575
- * A <code>SAXException</code> will also be thrown by the returned
576
- * <code>ContentHandler</code> during deserialization if
577
- * <code>uuidBehavior</code> is set to <code>IMPORT_UUID_COLLISION_REMOVE_EXISTING</code>
578
- * and an incoming node has the same identifier as the node at
579
- * <code>parentAbsPath</code> or one of its ancestors.
580
- * <p>
581
- * A <code>PathNotFoundException</code> is thrown either immediately, on
582
- * dispatch or on persist, if no node exists at <code>parentAbsPath</code>.
583
- * Implementations may differ on when this validation is performed
584
- * <p>
585
- * A <code>ConstraintViolationException</code> is thrown either immediately,
586
- * on dispatch or on persist, if the new subgraph cannot be added to the
587
- * node at <code>parentAbsPath</code> due to node-type or other
588
- * implementation-specific constraints, and this can be determined before
589
- * the first SAX event is sent. Implementations may differ on when this
590
- * validation is performed.
591
- * <p>
592
- * A <code>VersionException</code> is thrown either immediately, on dispatch
593
- * or on persist, if the node at <code>parentAbsPath</code> is read-only due
594
- * to a check-in. Implementations may differ on when this validation is
595
- * performed.
596
- * <p>
597
- * A <code>LockException</code> is thrown either immediately, on dispatch or
598
- * on persist, if a lock prevents the addition of the subgraph.
599
- * Implementations may differ on when this validation is performed.
600
- *
601
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
602
- * @param parentAbsPath the absolute path of a node under which (as child) the imported subgraph will be built.
603
- * @param uuidBehavior a four-value flag that governs how incoming identifiers are handled.
604
- * @return an org.xml.sax.ContentHandler whose methods may be called to feed SAX events into the deserializer.
605
- * @throws PathNotFoundException if no node exists at <code>parentAbsPath</code> and this implementation performs this validation immediately.
606
- * @throws ConstraintViolationException if the new subgraph cannot be added to the node at <code>parentAbsPath</code> due to node-type or other implementation-specific constraints, and this implementation performs this validation immediately.
607
- * @throws VersionException if the node at <code>parentAbsPath</code> is read-only due to a checked-in node and this implementation performs this validation immediately.
608
- * @throws LockException if a lock prevents the addition of the subgraph and this implementation performs this validation immediately.
609
- * @throws RepositoryException if another error occurs.
610
- */
611
- export function getImportContentHandler(
612
- parentAbsPath: string,
613
- uuidBehavior: number
614
- ): unknown;
615
-
616
- /**
617
- * Deserializes an XML document and adds the resulting item subgraph as a
618
- * child of the node at <code>parentAbsPath</code>.
619
- * <p>
620
- * If the incoming XML stream does not appear to be a JCR <i>system view</i>
621
- * XML document then it is interpreted as a <i>document view</i> XML
622
- * document.
623
- * <p>
624
- * The passed <code>InputStream</code> is closed before this method returns
625
- * either normally or because of an exception.
626
- * <p>
627
- * The tree of new items is built in the transient storage of the
628
- * <code>Session</code>. In order to persist the new content,
629
- * <code>save</code> must be called. The advantage of this
630
- * through-the-session method is that (depending on what constraint checks
631
- * the implementation leaves until <code>save</code>) structures that
632
- * violate node type constraints can be imported, fixed and then saved. The
633
- * disadvantage is that a large import will result in a large cache of
634
- * pending nodes in the session. See {@link Workspace#importXML} for a
635
- * version of this method that does not go through the
636
- * <code>Session</code>.
637
- * <p>
638
- * The flag <code>uuidBehavior</code> governs how the identifiers of
639
- * incoming nodes are handled. There are four options: <ul> <li> {@link
640
- * ImportUUIDBehavior#IMPORT_UUID_CREATE_NEW}: Incoming nodes are added in
641
- * the same way that new node is added with <code>Node.addNode</code>. That
642
- * is, they are either assigned newly created identifiers upon addition or
643
- * upon <code>save</code> (depending on the implementation, see <i>4.9.1.1
644
- * When Identifiers are Assigned</i> in the specification). In either case,
645
- * identifier collisions will not occur. </li> <li> {@link
646
- * ImportUUIDBehavior#IMPORT_UUID_COLLISION_REMOVE_EXISTING}: If an incoming
647
- * node has the same identifier as a node already existing in the workspace
648
- * then the already existing node (and its subgraph) is removed from
649
- * wherever it may be in the workspace before the incoming node is added.
650
- * Note that this can result in nodes "disappearing" from locations in the
651
- * workspace that are remote from the location to which the incoming
652
- * subgraph is being written. Both the removal and the new addition will be
653
- * dispatched on <code>save</code>. </li> <li> {@link
654
- * ImportUUIDBehavior#IMPORT_UUID_COLLISION_REPLACE_EXISTING}: If an
655
- * incoming node has the same identifier as a node already existing in the
656
- * workspace, then the already-existing node is replaced by the incoming
657
- * node in the same position as the existing node. Note that this may result
658
- * in the incoming subgraph being disaggregated and "spread around" to
659
- * different locations in the workspace. In the most extreme case this
660
- * behavior may result in no node at all being added as child of
661
- * <code>parentAbsPath</code>. This will occur if the topmost element of the
662
- * incoming XML has the same identifier as an existing node elsewhere in the
663
- * workspace. The change will be dispatched on <code>save</code>. </li> <li>
664
- * {@link ImportUUIDBehavior#IMPORT_UUID_COLLISION_THROW}: If an incoming
665
- * node has the same identifier as a node already existing in the workspace
666
- * then an <code>ItemExistsException</code> is thrown. </li> </ul> Unlike
667
- * {@link Workspace#importXML}, this method does not necessarily enforce all
668
- * node type constraints during deserialization. Those that would be
669
- * immediately enforced in a normal write method (<code>Node.addNode</code>,
670
- * <code>Node.setProperty</code> etc.) of this implementation cause an
671
- * immediate <code>ConstraintViolationException</code> during
672
- * deserialization. All other constraints are checked on <code>save</code>,
673
- * just as they are in normal write operations. However, which node type
674
- * constraints are enforced depends upon whether node type information in
675
- * the imported data is respected, and this is an implementation-specific
676
- * issue.
677
- * <p>
678
- * A <code>ConstraintViolationException</code> will also be thrown
679
- * immediately if <code>uuidBehavior</code> is set to
680
- * <code>IMPORT_UUID_COLLISION_REMOVE_EXISTING</code> and an incoming node
681
- * has the same identifier as the node at <code>parentAbsPath</code> or one
682
- * of its ancestors.
683
- * <p>
684
- * A <code>PathNotFoundException</code> is thrown either immediately, on
685
- * dispatch or on persist, if no node exists at <code>parentAbsPath</code>.
686
- * Implementations may differ on when this validation is performed
687
- * <p>
688
- * A <code>ConstraintViolationException</code> is thrown either immediately,
689
- * on dispatch or on persist, if the new subgraph cannot be added to the
690
- * node at <code>parentAbsPath</code> due to node-type or other
691
- * implementation-specific constraints. Implementations may differ on when
692
- * this validation is performed.
693
- * <p>
694
- * A <code>VersionException</code> is thrown either immediately, on dispatch
695
- * or on persist, if the node at <code>parentAbsPath</code> is read-only due
696
- * to a check-in. Implementations may differ on when this validation is
697
- * performed.
698
- * <p>
699
- * A <code>LockException</code> is thrown either immediately, on dispatch or
700
- * on persist, if a lock prevents the addition of the subgraph.
701
- * Implementations may differ on when this validation is performed.
702
- *
703
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
704
- * @param parentAbsPath the absolute path of the node below which the deserialized subgraph is added.
705
- * @param in The <code>Inputstream</code> from which the XML to be deserialized is read.
706
- * @param uuidBehavior a four-value flag that governs how incoming identifiers are handled.
707
- * @throws java.io.IOException if an error during an I/O operation occurs.
708
- * @throws PathNotFoundException if no node exists at <code>parentAbsPath</code> and this implementation performs this validation immediately.
709
- * @throws ItemExistsException if deserialization would overwrite an existing item and this implementation performs this validation immediately.
710
- * @throws ConstraintViolationException if a node type or other implementation-specific constraint is violated that would be checked on a session-write method or if <code>uuidBehavior</code> is set to <code>IMPORT_UUID_COLLISION_REMOVE_EXISTING</code> and an incoming node has the same UUID as the node at <code>parentAbsPath</code> or one of its ancestors.
711
- * @throws VersionException if the node at <code>parentAbsPath</code> is read-only due to a checked-in node and this implementation performs this validation immediately.
712
- * @throws InvalidSerializedDataException if incoming stream is not a valid XML document.
713
- * @throws LockException if a lock prevents the addition of the subgraph and this implementation performs this validation immediately.
714
- * @throws RepositoryException if another error occurs.
715
- */
716
- export function importXML(
717
- parentAbsPath: string,
718
- _in: unknown,
719
- uuidBehavior: number
720
- ): void;
721
-
722
- /**
723
- * Serializes the node (and if <code>noRecurse</code> is <code>false</code>,
724
- * the whole subgraph) at <code>absPath</code> into a series of SAX events
725
- * by calling the methods of the supplied <code>org.xml.sax.ContentHandler</code>.
726
- * The resulting XML is in the system view form. Note that
727
- * <code>absPath</code> must be the path of a node, not a property.
728
- * <p>
729
- * If <code>skipBinary</code> is true then any properties of
730
- * <code>PropertyType.BINARY</code> will be serialized as if they are empty.
731
- * That is, the existence of the property will be serialized, but its
732
- * content will not appear in the serialized output (the
733
- * <code>&lt;sv:value&gt;</code> element will have no content). Note that in
734
- * the case of multi-value <code>BINARY</code> properties, the number of
735
- * values in the property will be reflected in the serialized output, though
736
- * they will all be empty. If <code>skipBinary</code> is false then the
737
- * actual value(s) of each <code>BINARY</code> property is recorded using
738
- * Base64 encoding.
739
- * <p>
740
- * If <code>noRecurse</code> is true then only the node at
741
- * <code>absPath</code> and its properties, but not its child nodes, are
742
- * serialized. If <code>noRecurse</code> is <code>false</code> then the
743
- * entire subgraph rooted at <code>absPath</code> is serialized.
744
- * <p>
745
- * If the user lacks read access to some subsection of the specified tree,
746
- * that section simply does not get serialized, since, from the user's point
747
- * of view, it is not there.
748
- * <p>
749
- * The serialized output will reflect the state of the current workspace as
750
- * modified by the state of this <code>Session</code>. This means that
751
- * pending changes (regardless of whether they are valid according to node
752
- * type constraints) and all namespace mappings in the namespace registry,
753
- * as modified by the current session-mappings, are reflected in the
754
- * output.
755
- * <p>
756
- * The output XML will be encoded in UTF-8.
757
- *
758
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
759
- * @param absPath The path of the root of the subgraph to be serialized. This must be the path to a node, not a property
760
- * @param contentHandler The <code>org.xml.sax.ContentHandler</code> to which the SAX events representing the XML serialization of the subgraph will be output.
761
- * @param skipBinary A <code>boolean</code> governing whether binary properties are to be serialized.
762
- * @param noRecurse A <code>boolean</code> governing whether the subgraph at absPath is to be recursed.
763
- * @throws PathNotFoundException if no node exists at <code>absPath</code>.
764
- * @throws org.xml.sax.SAXException if an error occurs while feeding events to the <code>org.xml.sax.ContentHandler</code>.
765
- * @throws RepositoryException if another error occurs.
766
- */
767
- export function exportSystemView(
768
- absPath: string,
769
- contentHandler: unknown,
770
- skipBinary: boolean,
771
- noRecurse: boolean
772
- ): void;
773
-
774
- /**
775
- * Serializes the node (and if <code>noRecurse</code> is <code>false</code>,
776
- * the whole subgraph) at <code>absPath</code> as an XML stream and outputs
777
- * it to the supplied <code>OutputStream</code>. The resulting XML is in the
778
- * system view form. Note that <code>absPath</code> must be the path of a
779
- * node, not a property.
780
- * <p>
781
- * If <code>skipBinary</code> is true then any properties of
782
- * <code>PropertyType.BINARY</code> will be serialized as if they are empty.
783
- * That is, the existence of the property will be serialized, but its
784
- * content will not appear in the serialized output (the
785
- * <code>&lt;sv:value&gt;</code> element will have no content). Note that in
786
- * the case of multi-value <code>BINARY</code> properties, the number of
787
- * values in the property will be reflected in the serialized output, though
788
- * they will all be empty. If <code>skipBinary</code> is false then the
789
- * actual value(s) of each <code>BINARY</code> property is recorded using
790
- * Base64 encoding.
791
- * <p>
792
- * If <code>noRecurse</code> is true then only the node at
793
- * <code>absPath</code> and its properties, but not its child nodes, are
794
- * serialized. If <code>noRecurse</code> is <code>false</code> then the
795
- * entire subgraph rooted at <code>absPath</code> is serialized.
796
- * <p>
797
- * If the user lacks read access to some subsection of the specified tree,
798
- * that section simply does not get serialized, since, from the user's point
799
- * of view, it is not there.
800
- * <p>
801
- * The serialized output will reflect the state of the current workspace as
802
- * modified by the state of this <code>Session</code>. This means that
803
- * pending changes (regardless of whether they are valid according to node
804
- * type constraints) and all namespace mappings in the namespace registry,
805
- * as modified by the current session-mappings, are reflected in the
806
- * output.
807
- * <p>
808
- * The output XML will be encoded in UTF-8.
809
- * <p>
810
- * It is the responsibility of the caller to close the passed
811
- * <code>OutputStream</code>.
812
- *
813
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
814
- * @param absPath The path of the root of the subgraph to be serialized. This must be the path to a node, not a property
815
- * @param out The <code>OutputStream</code> to which the XML serialization of the subgraph will be output.
816
- * @param skipBinary A <code>boolean</code> governing whether binary properties are to be serialized.
817
- * @param noRecurse A <code>boolean</code> governing whether the subgraph at absPath is to be recursed.
818
- * @throws PathNotFoundException if no node exists at <code>absPath</code>.
819
- * @throws IOException if an error during an I/O operation occurs.
820
- * @throws RepositoryException if another error occurs.
821
- */
822
- export function exportSystemView(
823
- absPath: string,
824
- out: unknown,
825
- skipBinary: boolean,
826
- noRecurse: boolean
827
- ): void;
828
-
829
- /**
830
- * Serializes the node (and if <code>noRecurse</code> is <code>false</code>,
831
- * the whole subgraph) at <code>absPath</code> into a series of SAX events
832
- * by calling the methods of the supplied <code>org.xml.sax.ContentHandler</code>.
833
- * The resulting XML is in the document view form. Note that
834
- * <code>absPath</code> must be the path of a node, not a property.
835
- * <p>
836
- * If <code>skipBinary</code> is true then any properties of
837
- * <code>PropertyType.BINARY</code> will be serialized as if they are empty.
838
- * That is, the existence of the property will be serialized, but its
839
- * content will not appear in the serialized output (the value of the
840
- * attribute will be empty). If <code>skipBinary</code> is false then the
841
- * actual value(s) of each <code>BINARY</code> property is recorded using
842
- * Base64 encoding.
843
- * <p>
844
- * If <code>noRecurse</code> is true then only the node at
845
- * <code>absPath</code> and its properties, but not its child nodes, are
846
- * serialized. If <code>noRecurse</code> is <code>false</code> then the
847
- * entire subgraph rooted at <code>absPath</code> is serialized.
848
- * <p>
849
- * If the user lacks read access to some subsection of the specified tree,
850
- * that section simply does not get serialized, since, from the user's point
851
- * of view, it is not there.
852
- * <p>
853
- * The serialized output will reflect the state of the current workspace as
854
- * modified by the state of this <code>Session</code>. This means that
855
- * pending changes (regardless of whether they are valid according to node
856
- * type constraints) and all namespace mappings in the namespace registry,
857
- * as modified by the current session-mappings, are reflected in the
858
- * output.
859
- * <p>
860
- * The output XML will be encoded in UTF-8.
861
- *
862
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
863
- * @param absPath The path of the root of the subgraph to be serialized. This must be the path to a node, not a property
864
- * @param contentHandler The <code>org.xml.sax.ContentHandler</code> to which the SAX events representing the XML serialization of the subgraph will be output.
865
- * @param skipBinary A <code>boolean</code> governing whether binary properties are to be serialized.
866
- * @param noRecurse A <code>boolean</code> governing whether the subgraph at absPath is to be recursed.
867
- * @throws PathNotFoundException if no node exists at <code>absPath</code>.
868
- * @throws org.xml.sax.SAXException if an error occurs while feeding events to the <code>org.xml.sax.ContentHandler</code>.
869
- * @throws RepositoryException if another error occurs.
870
- */
871
- export function exportDocumentView(
872
- absPath: string,
873
- contentHandler: unknown,
874
- skipBinary: boolean,
875
- noRecurse: boolean
876
- ): void;
877
-
878
- /**
879
- * Serializes the node (and if <code>noRecurse</code> is <code>false</code>,
880
- * the whole subgraph) at <code>absPath</code> as an XML stream and outputs
881
- * it to the supplied <code>OutputStream</code>. The resulting XML is in the
882
- * document view form. Note that <code>absPath</code> must be the path of a
883
- * node, not a property.
884
- * <p>
885
- * If <code>skipBinary</code> is true then any properties of
886
- * <code>PropertyType.BINARY</code> will be serialized as if they are empty.
887
- * That is, the existence of the property will be serialized, but its
888
- * content will not appear in the serialized output (the value of the
889
- * attribute will be empty). If <code>skipBinary</code> is false then the
890
- * actual value(s) of each <code>BINARY</code> property is recorded using
891
- * Base64 encoding.
892
- * <p>
893
- * If <code>noRecurse</code> is true then only the node at
894
- * <code>absPath</code> and its properties, but not its child nodes, are
895
- * serialized. If <code>noRecurse</code> is <code>false</code> then the
896
- * entire subgraph rooted at <code>absPath</code> is serialized.
897
- * <p>
898
- * If the user lacks read access to some subsection of the specified tree,
899
- * that section simply does not get serialized, since, from the user's point
900
- * of view, it is not there.
901
- * <p>
902
- * The serialized output will reflect the state of the current workspace as
903
- * modified by the state of this <code>Session</code>. This means that
904
- * pending changes (regardless of whether they are valid according to node
905
- * type constraints) and all namespace mappings in the namespace registry,
906
- * as modified by the current session-mappings, are reflected in the
907
- * output.
908
- * <p>
909
- * The output XML will be encoded in UTF-8.
910
- * <p>
911
- * It is the responsibility of the caller to close the passed
912
- * <code>OutputStream</code>.
913
- *
914
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
915
- * @param absPath The path of the root of the subgraph to be serialized. This must be the path to a node, not a property
916
- * @param out The <code>OutputStream</code> to which the XML serialization of the subgraph will be output.
917
- * @param skipBinary A <code>boolean</code> governing whether binary properties are to be serialized.
918
- * @param noRecurse A <code>boolean</code> governing whether the subgraph at absPath is to be recursed.
919
- * @throws PathNotFoundException if no node exists at <code>absPath</code>.
920
- * @throws IOException if an error during an I/O operation occurs.
921
- * @throws RepositoryException if another error occurs.
922
- */
923
- export function exportDocumentView(
924
- absPath: string,
925
- out: unknown,
926
- skipBinary: boolean,
927
- noRecurse: boolean
928
- ): void;
929
-
930
- /**
931
- * Within the scope of this <code>Session</code>, this method maps
932
- * <code>uri</code> to <code>prefix</code>. The remapping only affects
933
- * operations done through this <code>Session</code>. To clear all
934
- * remappings, the client must acquire a new <code>Session</code>.
935
- * <p>
936
- * All local mappings already present in the <code>Session</code> that
937
- * include either the specified <code>prefix</code> or the specified
938
- * <code>uri</code> are removed and the new mapping is added.
939
- *
940
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
941
- * @param prefix a string
942
- * @param uri a string
943
- * @throws NamespaceException if an attempt is made to map a namespace URI to a prefix beginning with the characters "<code>xml</code>" (in any combination of case) or if an attempt is made to map either the empty prefix or the empty namespace (i.e., if either <code>prefix</code> or <code>uri</code> are the empty string).
944
- * @throws RepositoryException if another error occurs.
945
- */
946
- export function setNamespacePrefix(prefix: string, uri: string): void;
947
-
948
- /**
949
- * Returns all prefixes currently mapped to URIs in this
950
- * <code>Session</code>.
951
- * @return a string array
952
- * @throws RepositoryException if an error occurs
953
- */
954
- export function getNamespacePrefixes(): string;
955
-
956
- /**
957
- * Returns the URI to which the given <code>prefix</code> is mapped as
958
- * currently set in this <code>Session</code>.
959
- * @param prefix a string
960
- * @return a string
961
- * @throws NamespaceException if the specified <code>prefix</code> is unknown.
962
- * @throws RepositoryException if another error occurs
963
- */
964
- export function getNamespaceURI(prefix: string): string;
965
-
966
- /**
967
- * Returns the prefix to which the given <code>uri</code> is mapped as
968
- * currently set in this <code>Session</code>.
969
- * @param uri a string
970
- * @return a string
971
- * @throws NamespaceException if the specified <code>uri</code> is unknown.
972
- * @throws RepositoryException if another error occurs
973
- */
974
- export function getNamespacePrefix(uri: string): string;
975
-
976
- /**
977
- * Releases all resources associated with this <code>Session</code>. This
978
- * method should be called when a <code>Session</code> is no longer needed.
979
-
980
- */
981
- export function logout(): void;
982
-
983
- /**
984
- * Returns <code>true</code> if this <code>Session</code> object is usable
985
- * by the client. Otherwise, returns <code>false</code>. A usable
986
- * <code>Session</code> is one that is neither logged-out, timed-out nor in
987
- * any other way disconnected from the repository.
988
- * @return <code>true</code> if this <code>Session</code> is usable, <code>false</code> otherwise.
989
- */
990
- export function isLive(): boolean;
991
-
992
- /**
993
- * Adds the specified lock token to this <code>Session</code>. Holding a
994
- * lock token makes this <code>Session</code> the owner of the lock
995
- * specified by that particular lock token.
996
- *
997
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
998
- * @param lt a lock token (a string).
999
- * @deprecated As of JCR 2.0, {@link LockManager#addLockToken(String)} should be used instead.
1000
- */
1001
- export function addLockToken(lt: string): void;
1002
-
1003
- /**
1004
- * Returns an array containing all lock tokens currently held by this
1005
- * <code>Session</code>. Note that any such tokens will represent
1006
- * open-scoped locks, since session-scoped locks do not have tokens.
1007
- *
1008
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1009
- * @return an array of lock tokens (strings)
1010
- * @deprecated As of JCR 2.0, {@link LockManager#getLockTokens()} should be used instead.
1011
- */
1012
- export function getLockTokens(): string;
1013
-
1014
- /**
1015
- * Removes the specified lock token from this <code>Session</code>.
1016
- *
1017
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1018
- * @param lt a lock token (a string)
1019
- * @deprecated As of JCR 2.0, {@link LockManager#removeLockToken(String)} should be used instead.
1020
- */
1021
- export function removeLockToken(lt: string): void;
1022
-
1023
- /**
1024
- * Returns the access control manager for this <code>Session</code>.
1025
- *
1026
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1027
- * @return the access control manager for this <code>Session</code>
1028
- * @throws UnsupportedRepositoryOperationException if access control is not supported.
1029
- * @throws RepositoryException if another error occurs.
1030
- * @since JCR 2.0
1031
- */
1032
- export function getAccessControlManager(): AccessControlManager;
1033
-
1034
- /**
1035
- * Returns the retention and hold manager for this <code>Session</code>.
1036
- *
1037
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1038
- * @return the retention manager for this <code>Session</code>.
1039
- * @throws UnsupportedRepositoryOperationException if retention and hold are not supported.
1040
- * @throws RepositoryException if another error occurs.
1041
- * @since JCR 2.0
1042
- */
1043
- export function getRetentionManager(): RetentionManager;
11
+ import type AccessControlManager from "../../types/javax/jcr/security/AccessControlManager";
12
+ import type RetentionManager from "../../types/javax/jcr/retention/RetentionManager";
1044
13
 
1045
14
  /**
1046
15
  * The <code>Session</code> object provides read and (in level 2) write access
@@ -1083,68 +52,257 @@ export function getRetentionManager(): RetentionManager;
1083
52
  * </p>
1084
53
  * <pre><em><code>
1085
54
  * #set ($jcrSession = $request.getAttribute('sitevision.jcr.session'))
1086
- * </code></em></pre>A constant representing the <code>read</code> action string, used to
1087
- * determine if this <code>Session</code> has permission to retrieve an item
1088
- * (and read the value, in the case of a property).A constant representing the <code>add_node</code> action string, used to
1089
- * determine if this <code>Session</code> has permission to add a new node.A constant representing the <code>set_property</code> action string, used
1090
- * to determine if this <code>Session</code> has permission to set (add or
1091
- * modify) a property.A constant representing the <code>remove</code> action string, used to
1092
- * determine if this <code>Session</code> has permission to remove an item.
1093
- * @see #hasPermission(String, String)
1094
- * @see #checkPermission(String, String)
1095
- * @since JCR 2.0
1096
- * @see #hasPermission(String, String)
1097
- * @see #checkPermission(String, String)
1098
- * @since JCR 2.0
1099
- * @see #hasPermission(String, String)
1100
- * @see #checkPermission(String, String)
1101
- * @since JCR 2.0
1102
- * @see #hasPermission(String, String)
1103
- * @see #checkPermission(String, String)
1104
- * @since JCR 2.0
1105
- */
1106
- declare namespace session {
1107
- export {
1108
- getRepository,
1109
- getUserID,
1110
- getAttributeNames,
1111
- getAttribute,
1112
- getWorkspace,
1113
- getRootNode,
1114
- impersonate,
1115
- getNodeByUUID,
1116
- getNodeByIdentifier,
1117
- getItem,
1118
- getNode,
1119
- getProperty,
1120
- itemExists,
1121
- nodeExists,
1122
- propertyExists,
1123
- move,
1124
- removeItem,
1125
- save,
1126
- refresh,
1127
- hasPendingChanges,
1128
- getValueFactory,
1129
- hasPermission,
1130
- checkPermission,
1131
- hasCapability,
1132
- getImportContentHandler,
1133
- importXML,
1134
- exportSystemView,
1135
- exportDocumentView,
1136
- setNamespacePrefix,
1137
- getNamespacePrefixes,
1138
- getNamespaceURI,
1139
- getNamespacePrefix,
1140
- logout,
1141
- isLive,
1142
- addLockToken,
1143
- getLockTokens,
1144
- removeLockToken,
1145
- getAccessControlManager,
1146
- getRetentionManager,
1147
- };
55
+ * </code></em></pre>
56
+
57
+ */
58
+ export interface Session {
59
+ /**
60
+ * A constant representing the <code>read</code> action string, used to
61
+ * determine if this <code>Session</code> has permission to retrieve an item
62
+ * (and read the value, in the case of a property).
63
+ * @see #hasPermission(String, String)
64
+ * @see #checkPermission(String, String)
65
+ * @since JCR 2.0
66
+ */
67
+ ACTION_READ: "read";
68
+
69
+ /**
70
+ * A constant representing the <code>add_node</code> action string, used to
71
+ * determine if this <code>Session</code> has permission to add a new node.
72
+ * @see #hasPermission(String, String)
73
+ * @see #checkPermission(String, String)
74
+ * @since JCR 2.0
75
+ */
76
+ ACTION_ADD_NODE: "add_node";
77
+
78
+ /**
79
+ * A constant representing the <code>set_property</code> action string, used
80
+ * to determine if this <code>Session</code> has permission to set (add or
81
+ * modify) a property.
82
+ * @see #hasPermission(String, String)
83
+ * @see #checkPermission(String, String)
84
+ * @since JCR 2.0
85
+ */
86
+ ACTION_SET_PROPERTY: "set_property";
87
+
88
+ /**
89
+ * A constant representing the <code>remove</code> action string, used to
90
+ * determine if this <code>Session</code> has permission to remove an item.
91
+ * @see #hasPermission(String, String)
92
+ * @see #checkPermission(String, String)
93
+ * @since JCR 2.0
94
+ */
95
+ ACTION_REMOVE: "remove";
96
+
97
+ /**
98
+ * Returns the <code>Repository</code> object through which this session was
99
+ * acquired.
100
+ * @return a <code>{@link Repository}</code> object.
101
+ */
102
+ getRepository(): Repository;
103
+
104
+ /**
105
+ * Gets the user ID associated with this <code>Session</code>. How the user
106
+ * ID is set is up to the implementation, it may be a string passed in as
107
+ * part of the credentials or it may be a string acquired in some other way.
108
+ * This method is free to return an "anonymous user ID" or
109
+ * <code>null</code>.
110
+ * @return the user ID associated with this <code>Session</code>.
111
+ */
112
+ getUserID(): string;
113
+
114
+ /**
115
+ * Returns the names of the attributes set in this session as a result of
116
+ * the <code>Credentials</code> that were used to acquire it. Not all
117
+ * <code>Credentials</code> implementations will contain attributes (though,
118
+ * for example, <code>SimpleCredentials</code> does allow for them). This
119
+ * method returns an empty array if the <code>Credentials</code> instance
120
+ * did not provide attributes.
121
+ * @return A string array containing the names of all attributes passed in the credentials used to acquire this session.
122
+ */
123
+ getAttributeNames(): string;
124
+
125
+ /**
126
+ * Returns the value of the named attribute as an <code>Object</code>, or
127
+ * <code>null</code> if no attribute of the given name exists. See {@link
128
+ * Session#getAttributeNames}.
129
+ * @param name the name of an attribute passed in the credentials used to acquire this session.
130
+ * @return the value of the attribute or <code>null</code> if no attribute of the given name exists.
131
+ */
132
+ getAttribute(name: string): unknown;
133
+
134
+ /**
135
+ * Returns the <code>Workspace</code> attached to this
136
+ * <code>Session</code>.
137
+ * @return a <code>{@link Workspace}</code> object.
138
+ */
139
+ getWorkspace(): Workspace;
140
+
141
+ /**
142
+ * Returns the root node of the workspace, "/". This node is the main access
143
+ * point to the content of the workspace.
144
+ * @return The root node of the workspace: a <code>{@link Node}</code> object.
145
+ * @throws RepositoryException if an error occurs.
146
+ */
147
+ getRootNode(): Node;
148
+
149
+ /**
150
+ * Returns a new session in accordance with the specified (new) Credentials.
151
+ * Allows the current user to "impersonate" another using incomplete or
152
+ * relaxed credentials requirements (perhaps including a user name but no
153
+ * password, for example), assuming that this <code>Session</code> gives
154
+ * them that permission.
155
+ * <p>
156
+ * The new <code>Session</code> is tied to a new <code>Workspace</code>
157
+ * instance. In other words, <code>Workspace</code> instances are not
158
+ * re-used. However, the <code>Workspace</code> instance returned represents
159
+ * the same actual persistent workspace entity in the repository as is
160
+ * represented by the <code>Workspace</code> object tied to this
161
+ * <code>Session</code>.
162
+ * @param credentials A <code>Credentials</code> object
163
+ * @return a <code>Session</code> object
164
+ * @throws LoginException if the current session does not have sufficient access to perform the operation.
165
+ * @throws RepositoryException if another error occurs.
166
+ */
167
+ impersonate(credentials: Credentials): Session;
168
+
169
+ /**
170
+ * Returns the node specified by the given identifier. Applies to both
171
+ * referenceable and non-referenceable nodes.
172
+ * @param id An identifier.
173
+ * @return A <code>Node</code>.
174
+ * @throws ItemNotFoundException if no node with the specified identifier exists or if this <code>Session</code> does not have read access to the node with the specified identifier.
175
+ * @throws RepositoryException if another error occurs.
176
+ * @since JCR 2.0
177
+ */
178
+ getNodeByIdentifier(id: string): Node;
179
+
180
+ /**
181
+ * Returns the node at the specified absolute path in the workspace. If no
182
+ * such node exists, then it returns the property at the specified path.
183
+ * <p>
184
+ * This method should only be used if the application does not know whether
185
+ * the item at the indicated path is property or node. In cases where the
186
+ * application has this information, either {@link #getNode} or {@link
187
+ * #getProperty} should be used, as appropriate. In many repository
188
+ * implementations the node and property-specific methods are likely to be
189
+ * more efficient than <code>getItem</code>.
190
+ * @param absPath An absolute path.
191
+ * @return the specified <code>Item</code>.
192
+ * @throws PathNotFoundException if no accessible item is found at the specified path.
193
+ * @throws RepositoryException if another error occurs.
194
+ */
195
+ getItem(absPath: string): Item;
196
+
197
+ /**
198
+ * Returns the node at the specified absolute path in the workspace.
199
+ * @param absPath An absolute path.
200
+ * @return the specified <code>Node</code>.
201
+ * @throws PathNotFoundException If no accessible node is found at the specifed path.
202
+ * @throws RepositoryException If another error occurs.
203
+ * @since JCR 2.0
204
+ */
205
+ getNode(absPath: string): Node;
206
+
207
+ /**
208
+ * Returns the property at the specified absolute path in the workspace.
209
+ * @param absPath An absolute path.
210
+ * @return the specified <code>Property</code>.
211
+ * @throws PathNotFoundException If no accessible property is found at the specified path.
212
+ * @throws RepositoryException if another error occurs.
213
+ * @since JCR 2.0
214
+ */
215
+ getProperty(absPath: string): Property;
216
+
217
+ /**
218
+ * Returns <code>true</code> if an item exists at <code>absPath</code> and
219
+ * this <code>Session</code> has read access to it; otherwise returns
220
+ * <code>false</code>.
221
+ * @param absPath An absolute path.
222
+ * @return a <code>boolean</code>
223
+ * @throws RepositoryException if <code>absPath</code> is not a well-formed absolute path.
224
+ */
225
+ itemExists(absPath: string): boolean;
226
+
227
+ /**
228
+ * Returns <code>true</code> if a node exists at <code>absPath</code> and
229
+ * this <code>Session</code> has read access to it; otherwise returns
230
+ * <code>false</code>.
231
+ * @param absPath An absolute path.
232
+ * @return a <code>boolean</code>
233
+ * @throws RepositoryException if <code>absPath</code> is not a well-formed absolute path.
234
+ * @since JCR 2.0
235
+ */
236
+ nodeExists(absPath: string): boolean;
237
+
238
+ /**
239
+ * Returns <code>true</code> if a property exists at <code>absPath</code>
240
+ * and this <code>Session</code> has read access to it; otherwise returns
241
+ * <code>false</code>.
242
+ * @param absPath An absolute path.
243
+ * @return a <code>boolean</code>
244
+ * @throws RepositoryException if <code>absPath</code> is not a well-formed absolute path.
245
+ * @since JCR 2.0
246
+ */
247
+ propertyExists(absPath: string): boolean;
248
+
249
+ /**
250
+ * This method returns a <code>ValueFactory</code> that is used to create
251
+ * <code>Value</code> objects for use when setting repository properties.
252
+ * @since Sitevision 3.0
253
+ * @return a <code>ValueFactory</code>
254
+ * @throws UnsupportedRepositoryOperationException if writing to the repository is not supported.
255
+ * @throws RepositoryException if another error occurs.
256
+ */
257
+ getValueFactory(): ValueFactory;
258
+
259
+ /**
260
+ * Returns all prefixes currently mapped to URIs in this
261
+ * <code>Session</code>.
262
+ * @return a string array
263
+ * @throws RepositoryException if an error occurs
264
+ */
265
+ getNamespacePrefixes(): string;
266
+
267
+ /**
268
+ * Returns the URI to which the given <code>prefix</code> is mapped as
269
+ * currently set in this <code>Session</code>.
270
+ * @param prefix a string
271
+ * @return a string
272
+ * @throws NamespaceException if the specified <code>prefix</code> is unknown.
273
+ * @throws RepositoryException if another error occurs
274
+ */
275
+ getNamespaceURI(prefix: string): string;
276
+
277
+ /**
278
+ * Returns the prefix to which the given <code>uri</code> is mapped as
279
+ * currently set in this <code>Session</code>.
280
+ * @param uri a string
281
+ * @return a string
282
+ * @throws NamespaceException if the specified <code>uri</code> is unknown.
283
+ * @throws RepositoryException if another error occurs
284
+ */
285
+ getNamespacePrefix(uri: string): string;
286
+
287
+ /**
288
+ * Releases all resources associated with this <code>Session</code>. This
289
+ * method should be called when a <code>Session</code> is no longer needed.
290
+
291
+ */
292
+ logout(): void;
293
+
294
+ /**
295
+ * Returns <code>true</code> if this <code>Session</code> object is usable
296
+ * by the client. Otherwise, returns <code>false</code>. A usable
297
+ * <code>Session</code> is one that is neither logged-out, timed-out nor in
298
+ * any other way disconnected from the repository.
299
+ * @return <code>true</code> if this <code>Session</code> is usable, <code>false</code> otherwise.
300
+ */
301
+ isLive(): boolean;
1148
302
  }
1149
303
 
1150
- export default session;
304
+ declare namespace Session {}
305
+
306
+ declare var session: Session;
307
+
308
+ export = session;