From a89e62ca22269e5b54a2bf0e4c3628b2a76c5270 Mon Sep 17 00:00:00 2001 From: Rob Rudin Date: Tue, 4 Jun 2024 11:47:56 -0400 Subject: [PATCH] Removing what appear to be obsolete files No references found to any of these files. Removing them means we don't need to exclude them in the `jar` task either. --- marklogic-client-api/build.gradle | 7 - .../src/main/resources/LICENSE.txt | 202 --- .../src/main/resources/Readme.txt | 27 - .../src/main/resources/error.xsd | 214 --- .../src/main/resources/property.xsd | 81 - .../src/main/resources/query-plan.xsd | 1312 -------------- .../src/main/resources/restapi-bindings.xjb | 52 - .../src/main/resources/search-bindings.xjb | 69 - .../src/main/resources/search.xsd | 1602 ----------------- .../src/main/resources/security.xsd | 1087 ----------- 10 files changed, 4653 deletions(-) delete mode 100644 marklogic-client-api/src/main/resources/LICENSE.txt delete mode 100644 marklogic-client-api/src/main/resources/Readme.txt delete mode 100644 marklogic-client-api/src/main/resources/error.xsd delete mode 100644 marklogic-client-api/src/main/resources/property.xsd delete mode 100644 marklogic-client-api/src/main/resources/query-plan.xsd delete mode 100644 marklogic-client-api/src/main/resources/restapi-bindings.xjb delete mode 100644 marklogic-client-api/src/main/resources/search-bindings.xjb delete mode 100644 marklogic-client-api/src/main/resources/search.xsd delete mode 100644 marklogic-client-api/src/main/resources/security.xsd diff --git a/marklogic-client-api/build.gradle b/marklogic-client-api/build.gradle index 03b1cac2f..b712b54e2 100644 --- a/marklogic-client-api/build.gradle +++ b/marklogic-client-api/build.gradle @@ -72,13 +72,6 @@ test { systemProperty "TEST_USE_REVERSE_PROXY_SERVER", testUseReverseProxyServer } -jar { - exclude ( - 'search.xsd', 'search-bindings.xjb', - '*.txt', 'property.xsd', - 'restapi-bindings.xjb', 'security.xsd' - ) -} task sourcesJar(type: Jar) { archiveClassifier = 'sources' exclude ('property', '*.xsd', '*.xjb') diff --git a/marklogic-client-api/src/main/resources/LICENSE.txt b/marklogic-client-api/src/main/resources/LICENSE.txt deleted file mode 100644 index be77a4758..000000000 --- a/marklogic-client-api/src/main/resources/LICENSE.txt +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright (c) 2022 MarkLogic Corporation - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/marklogic-client-api/src/main/resources/Readme.txt b/marklogic-client-api/src/main/resources/Readme.txt deleted file mode 100644 index 41e9fab56..000000000 --- a/marklogic-client-api/src/main/resources/Readme.txt +++ /dev/null @@ -1,27 +0,0 @@ -Copyright (c) 2022 MarkLogic Corporation - -MarkLogic Client API for Java version ${project.version} - -This distribution contains code and basic documentation for Client API for Java - -The directory structure is organized as follows: - -docs/ - This directory contains the API documentation (Javadoc). - -example/ - This directory contains cookbook examples and supporting data as well as - examples of content representation extensions. Please see the README.txt - file in the directory for more detail. - -lib/ - This directory contains jar files for the MarkLogic Java API - (marklogic-client-api-${project.version}.jar) as well as its library - dependencies. - -You are encouraged to join the MarkLogic developer mailing list: - - http://community.marklogic.com/discuss/ - -=================================================================== -MarkLogic Corp, http://marklogic.com diff --git a/marklogic-client-api/src/main/resources/error.xsd b/marklogic-client-api/src/main/resources/error.xsd deleted file mode 100644 index 9d14b35f0..000000000 --- a/marklogic-client-api/src/main/resources/error.xsd +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - - - - - A data item supplied with the error as text - - - - - - - - - - - - - - The data fields supplied with the error if present. - - - - - - - - Information on the cause of the error if available, - typically a nested error . - - - - - - - - HTTP Status text e.g "Not Found" - - - - - - - - HTTP Status code e.g 404 - - - - - - - - The message code from the exception, Error or Static Error if available. - - - - - - - - The formatted message from the message catalog if available, otherwise built in format. - - - - - - - - The message "text" from the message catalog if available - - - - - - - - - - - - - - - - - - - - - - - - - - - Root element of all error messages - - - - - - - - - - - - - - - - - - - - - - - - - - - The XQuery language version. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/marklogic-client-api/src/main/resources/property.xsd b/marklogic-client-api/src/main/resources/property.xsd deleted file mode 100644 index bb15c217e..000000000 --- a/marklogic-client-api/src/main/resources/property.xsd +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - A set of document properties. - - - - - - - - - - - - - - The container for properties. - - - - - - - - - - - A directory indicator. - - - - - - - - - - - - The indicator for a directory. - - - - - - - - - - The timestamp of last document modification. - - - - - - - - - - - A timestamp of the last time something was modified. - - - - - - - - - diff --git a/marklogic-client-api/src/main/resources/query-plan.xsd b/marklogic-client-api/src/main/resources/query-plan.xsd deleted file mode 100644 index e61d05cbe..000000000 --- a/marklogic-client-api/src/main/resources/query-plan.xsd +++ /dev/null @@ -1,1312 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 9000400 - - - - - - - - - - - - - - - 9000400 - - - - - - - - - - - - - - 9000400 - - - - - - - 9000400 - - - - - - - - - - - - - 9000400 - - - - - - - - - - - - - - - - - - - - - - - - 9000400 - - - - - - - - - - - - - - - - - - - - - - 9000400 - - - - - - - - 9000400 - - - - - - - - 9000400 - - - - - - - - 9000400 - - - - - - - - - - - - - - - 9000400 - - - - - - - - 9000400 - - - - - - - - - - - - - - - - - 9000400 - - - - - - - - - - - - - - - 9000400 - - - - - - - - - - - - - 9000400 - - - - - - - - - - - - - 9000400 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/marklogic-client-api/src/main/resources/restapi-bindings.xjb b/marklogic-client-api/src/main/resources/restapi-bindings.xjb deleted file mode 100644 index b655e7599..000000000 --- a/marklogic-client-api/src/main/resources/restapi-bindings.xjb +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/marklogic-client-api/src/main/resources/search-bindings.xjb b/marklogic-client-api/src/main/resources/search-bindings.xjb deleted file mode 100644 index 6dc3dec1d..000000000 --- a/marklogic-client-api/src/main/resources/search-bindings.xjb +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - Search options package]]> - - - - - - - - A <b>Options</b> consists of a list of options - configurations elements. - - - - - - - - - - - A <b>Constraint</b> has a name and a - specification - tied to an index or lexicon. - - - - - - - - - - - - - - - - - diff --git a/marklogic-client-api/src/main/resources/search.xsd b/marklogic-client-api/src/main/resources/search.xsd deleted file mode 100644 index b5639beee..000000000 --- a/marklogic-client-api/src/main/resources/search.xsd +++ /dev/null @@ -1,1602 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/marklogic-client-api/src/main/resources/security.xsd b/marklogic-client-api/src/main/resources/security.xsd deleted file mode 100644 index 47857448e..000000000 --- a/marklogic-client-api/src/main/resources/security.xsd +++ /dev/null @@ -1,1087 +0,0 @@ - - - - - - - - A document URI. - - - - - - - - - - - - - A document's URI. - - - "" - - - document uri specifies the URI - of the document in which the function is defined. If the function - resides in a module in the filesystem under the - marklogic-dir/Modules directory, then - the URI starts with a forward slash and is the path to the XQuery - module (for example, /MarkLogic/security.xqy). - - - - - - - - - A function local-name. - - - - - - - - - - - - - A function local-name. - - - "" - - - local name is - the local name of the function. - - - - - - - - - A namespace. - - - - - - - - - - - - - A namespace. - - - "" - - name space - specifies the namespace in which the function is defined. - - - - - - - - - A role amplification. - - - -

- - Amp Configuration Help

- -
- An - Amp grants - additional roles to a user temporarily while the user is - performing a certain task (executing a function). For - each amp, configure the following: - - -
-

Buttons and Tabs:

 -
    -
  • The - Summary - tab displays a list of all of the currently configured amps, - including the roles assigned to each amp.
    • -
  • The - Describe - tab, accessible from the Configuration page for each amp, - lists all of the roles associated with the amp.
    • -
  • The - Create - tab allows you to create new amps.
    • -
  • The - delete button deletes the - amp permanently.
    • -
- - - - - - - - - The amplification of additional roles. - - - - - - - - - - - - - - - - - - A function, built-in name, or representation of something to protect. - - - - - - - - - - - - - A URI to protect. - - - "" - - uri - specifies the protected base URI. - - - action - is a URI used to decribe the protected action. - - - - - - - - - The kind of privilege: execute, collection, or uri - - - true - - - - - - - - - - - - A protected "action" (or object). - - - true - - - - - - - - Privilege representation. - - - -

- - URI Privilege Configuration Help

- -
- A - URI Privilege - specifies the right to create a document within a base URI. Only - roles associated with the URI privilege can create documents - within the base URI. For each privilege, configure the - following: - - -

- - Execute Privilege Configuration Help

- -
- An Execute - Privilege specifies a protected action. Only roles - associated with the execute privilege can perform the protected - action. For each privilege, configure the following: - - -
-

Buttons and Tabs:

 -
    -
  • The - Summary - tab displays a list of all of the currently configured excecute - privileges, including the roles assigned to each - privilege. Click on the name of a privilege to configure - it.
    • -
  • The - Describe - tab, accessible from the Configuration page for each privilege, - lists all of the roles associated with the privilege.
    • -
  • The - Create - tab allows you to create new excecute privileges.
    • -
- - -
-

Buttons and Tabs:

 -
    -
  • The - Summary - tab displays a list opf all of the currently configured URI - privileges, including the roles assigned to each - privilege.
    • -
  • The - Describe - tab, accessible from the Configuration page for each privilege, - lists all of the roles associated with the privilege.
    • -
  • The - Create - tab allows you to create new URI privileges.
    • -
- - - - - - - - - A privilege on a function/built-in. - - - - - - - - - - - - - - - - - The action permitted on an object. - - - - - - - - - - - - - - - - The action/task permitted by a permission - - - - - - - - - - - - A permission. - - - - - - - - - - - - - - Permission representation. - - - - A - permission - is a pairing of a role with a capability (read, insert, update, - execute). - - - - - - - - - A set of permissions - - - - - - - - - - - - - The default set of permissions used in document creation. - - - - A - permission - is a pairing of a role with a capability (read, insert, update, - execute). default permissions are - optional fields that specify the default document permissions - associated with the user. If the user does not explicitly specify - permissions during document creation, the document will have the - user's default permissions - - - - - - - - - - The default set of collections used in document creation. - - - - default - collections are optional fields that specify the - default document collections - associated with the user. If the user does not explicitly specify - collections during document creation, the document will have - the user's default collections. A document can belong any number - of collections. - - - - - - - - - A set of collection uri's - - - - - - - - - - - - - The compartment that this role is part of. - - - - A - compartment - is an optional field that places the role into the named - compartment. If a document has any permissions - (role/capability pairs) with roles that have a compartment, - then the user must have those roles with each of the - compartments (regardless of which permission they are in) - to perform any of the capabilites. - - - true - "" - - - - - - - - A compartment for a role. - - - - - - - - - - - - - The Role name (unique) - - - "" - - role name - is the name of the role. - - - - - - - - - A role identifier (unique key). - - - xdmp:random() - true - - - - - - - - A security role - - - - - - - - - - - - - - - - - - - A security role. - - - -

- - Role Configuration Help

- -
- A Role - gives privileges and permissions to a user. - - -
-

Buttons and Tabs:

 -
    -
  • The - Summary - tab displays a list opf all of the currently configured users, - including the roles assigned to each user.
    • -
  • The - Configure - tab allows you to edit existing users.
    • -
  • The - Create - tab allows you to create new users.
    • -
- - - - - - - - - A set of role-ids - - - - - - - - - - - - - The roles assigned. - The roles assigned to the user. - - - - A user or another role can have multiple - roles. Roles assigned - to a user (or role) give privileges and permissions to the - user (or role). Check any roles to associate them with this - configuration. - - - URI - privileges - specifies the URI privileges associated with the role. - - - execute - privileges specifies the execute privileges associated - with the role. - - - - - - - - - - Encrypted Password. - - - - - - - - - - - - - Encrypted Password. - - - "" - - password - is the password for the user. - - - - - - - - - Password encryped for digest authentication - - - "" - true - - - - - - - - Encrypted password for ntlm authentication - - - "" - true - - - - - - - - For storing extra information for password checking. - - - - - - - - - - - - - For storing extra information for password checking. - - - "" - true - - - - - - - - An object's description. - - - - - - - - - - - An object's description. - - - "" - - description - is an optional field to describe the user. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A amp identifier (unique key). - - - xdmp:random() - true - - - - - - - - A database the module is found in. - - - 0 - true - database - - - database specifies the - name of the database in which the amped function resides. If - filesystem is selected, then the module which contains the - function must be under the - marklogic-dir/Modules directory. - - - - - - - - - A privilege identifier (unique key). - - - xdmp:random() - true - - - - - - - - - - - - - - - - - - - - Privilege name (unique) - - - "" - - privilege - name is the name of the URI privilege. - - - privilege - name is the name of the execute privilege. - - - - - - - - - User/login name (unique) - - - "" - - user name - is the name of the user. - - - - - - - - - An object's unique id. - - - - - - - - - - - - A user/login id (unique key). - - - xdmp:random() - true - - - - - - - - The user object - - - - - - - - - - - - - - - - - - - - - A database user. - - - -

- - User Configuration Help

- -
- A user is - a user of the system. For each user, configure the following: - - -
-

Buttons and Tabs:

 -
    -
  • The - Summary - tab displays a list opf all of the currently configured users, - including the roles assigned to each user.
    • -
  • The - Configure tab allows you to edit - existing users.
    • -
  • The - Create - tab allows you to create new users.
    • -
- - - - - - - - - A collection id (unique key). - - - xdmp:random() - true - - - - - - - - The uri for the collection. - - - - - - - - - - - - - The collection uri. - - - "" - - uri - specifies the URI of this collection. - - - A - permission - pairs a role with a capability. Only read and update - capabilities apply for collections.

Permissions defined at - the collection level only apply to the collection; they do not - apply to documents within the collection.

-

To insert or remove a document from a database, update - permission is needed at both the document and collection - levels.

 - - - - - - - - - The collection object - - - - - - - - - - - - - - A collection object. - - - -

- - Collection Configuration Help

- -
-

A - Collection - enables the retrieval of a set of related documents as a unit. - A document can belong to any number of collections.

-

A collection can be - protected or unprotected. A collection - created within the Admin Interface is a protected collection - and is stored in the security database. An unprotected - collection (created simply by a document stating that it belongs - to that collection upon document creation or update) is not - explicitly stored as an object in the security database.

-

For each collection, specify the following:

 - - -
-

Buttons and Tabs:

 -
    -
  • The - Summary - tab displays a list of all of the currently configured - collections, including the permissions assigned to each - collection.
    • -
  • The - Describe - tab, accessible from the Configuration page for each collection, - lists all of the permissions associated with the - collection.
    • -
  • The - Create - tab allows you to create new collections.
    • -
  • The - delete - button deletes the protected collection permanently (but it does - not delete any documents that might be in the - collection).
    • -
- - - - - - - - - The security database version. - - - - - - - - - - An authentication realm. - - - - - - - - - - - - - The authentication realm. - - - "public" - -

- - Security Configuration Help

- -
- - Realm - is the realm of the security database. It is used in authentication - and also forms part of the hash for digest authentication. Changing - it invalidates all user digest passwords. -
- - - - - - - - - Metadata about the database - - - - - - - - - - - - - - Metadata about the database - - - - - - -