You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by an...@apache.org on 2014/05/20 17:35:10 UTC
svn commit: r1596292 - in /jackrabbit/oak/trunk/oak-doc/src/site: ./
markdown/ markdown/oak_api/ markdown/plugins/ markdown/security/
Author: angela
Date: Tue May 20 15:35:09 2014
New Revision: 1596292
URL: http://svn.apache.org/r1596292
Log:
OAK-301 : oak docu
Added:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/error_codes.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/plugins/
jackrabbit/oak/trunk/oak-doc/src/site/markdown/plugins/blobstore.md
- copied, changed from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/blobstore.md
Removed:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/blobstore.md
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/authentication.md
jackrabbit/oak/trunk/oak-doc/src/site/site.xml
Added: jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/error_codes.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/error_codes.md?rev=1596292&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/error_codes.md (added)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/error_codes.md Tue May 20 15:35:09 2014
@@ -0,0 +1,74 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+ -->
+
+Error Codes
+================================================================================
+
+Since [OAK-764] the CommitFailedExceptions thrown by commit hooks in Oak come
+with error codes that help identify the cause of a problem and locate additional
+information about the issue. This page is an informal registry of common error codes.
+
+### Type Constraint
+
+#### Node type validation
+
+| OakConstraint000x | Primary and mixin type information |
+|-------------------|------------------------------------|
+| 0001 | The primary type X does not exist |
+| 0002 | Mixin type X used as the primary type |
+| 0003 | Abstract type X used as the primary type |
+| 0004 | No default primary type available for child node X |
+| 0005 | The mixin type X does not exist |
+| 0006 | Primary type X used as a mixin type |
+| 0007 | Abstract type X used as a mixin type |
+
+| OakConstraint002x | Presence of mandatory items |
+|-------------------|-------------------------------------------------|
+| 0021 | Mandatory property X not included in a new node |
+| 0022 | Mandatory property X can not be removed |
+| 0025 | Mandatory child node X not included in a new node |
+| 0026 | Mandatory child node X can not be removed |
+
+#### Privilege Validation
+
+| Code | Message |
+|-------------------|-------------------------------------------------|
+| 0041 | Modification of existing privilege definition X |
+| 0042 | Un-register privilege X |
+| 0043 | Next bits not updated |
+| 0044 | Privilege store not initialized |
+| 0047 | Invalid declared aggregate name X |
+| 0048 | PrivilegeBits are missing |
+| 0049 | PrivilegeBits already in used |
+| 0050 | Singular aggregation is equivalent to existing privilege. |
+| 0051 | Declared aggregate X is not a registered privilege |
+| 0052 | Detected circular aggregation |
+| 0053 | Custom aggregate privilege X is already covered. |
+
+#### User Validation
+
+_todo_
+
+### Type Access
+
+#### Permission Validation
+
+_todo_
+
+
+<!-- hidden references -->
+[OAK-764]: https://issues.apache.org/jira/browse/OAK-764
\ No newline at end of file
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md?rev=1596292&r1=1596291&r2=1596292&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md Tue May 20 15:35:09 2014
@@ -18,4 +18,44 @@
Oak API
--------------------------------------------------------------------------------
-_todo_
\ No newline at end of file
+_todo_
+
+- [ContentRepository]
+- [ContentSession]
+- [Root]
+- [Tree]
+- [PropertyState]
+
+#### Values
+
+- [PropertyValue]
+- [Type]
+- [Blob]
+
+#### Query
+
+- [QueryEngine]
+- [Query]
+- [ResultRow]
+
+#### Various
+
+- [AuthInfo] : see section [Authentication](../security/authentication/overview.html)
+- [Descriptors]
+- [CommitFailedException] : see also [Error Codes](error_codes.html)
+
+
+<!-- hidden references -->
+[ContentRepository]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/ContentRepository.html
+[ContentSession]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/ContentSession.html
+[Root]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/Root.html
+[Tree]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/Tree.html
+[PropertyState]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/PropertyState.html
+[PropertyValue]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/PropertyValue.html
+[Type]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/Type.html
+[Blob]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/Blob.html
+[QueryEngine]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/QueryEngine.html
+[Query]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/Query.html
+[ResultRow]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/ResultRow.html
+[Descriptors]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/Descriptors.html
+[CommitFailedException]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/CommitFailedException.html
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md?rev=1596292&r1=1596291&r2=1596292&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md Tue May 20 15:35:09 2014
@@ -91,7 +91,7 @@ All the configuration related to Mongo c
mongodb://sysop:moon@localhost
* **Read Preferences and Write Concern** - These also can be spcified as part of Mongo URI. Refer to
- [Read Preference and Write Concern](nodestore/documentmk.html#rw-preference) section for more details. For
+ [Read Preference and Write Concern](documentmk.html#rw-preference) section for more details. For
e.g. following would set _readPreference_ to _secondary_ and prefer replica with tag _dc:ny,rack:1_.
It would also specify the write timeout to 10 sec
Copied: jackrabbit/oak/trunk/oak-doc/src/site/markdown/plugins/blobstore.md (from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/blobstore.md)
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/plugins/blobstore.md?p2=jackrabbit/oak/trunk/oak-doc/src/site/markdown/plugins/blobstore.md&p1=jackrabbit/oak/trunk/oak-doc/src/site/markdown/blobstore.md&r1=1596221&r2=1596292&rev=1596292&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/blobstore.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/plugins/blobstore.md Tue May 20 15:35:09 2014
@@ -87,7 +87,7 @@ In addition there are some more implemen
Depending on NodeStore type and usage requirement these can be configured to use
a particular BlobStore implementation. For OSGi env refer to [Configuring DataStore/BlobStore]
-(osgi_config.html#config-blobstore)
+(../osgi_config.html#config-blobstore)
#### SegmentNodeStore
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/authentication.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/authentication.md?rev=1596292&r1=1596291&r2=1596292&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/authentication.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/authentication.md Tue May 20 15:35:09 2014
@@ -333,7 +333,7 @@ defines some extensions points that allo
In addition this package contains various utilities and base implementations.
Most notably an abstract login module implementation ([AbstractLoginModule]) as
-described below.
+described below and a default implementation of the AuthInfo interface ([AuthInfoImpl]).
##### Abstract Login Module
@@ -474,7 +474,8 @@ implementation on various levels:
[javax.jcr.Repository]: http://www.day.com/specs/javax.jcr/javadocs/jcr-2.0/javax/jcr/Repository.html
[org.apache.jackrabbit.api.JackrabbitRepository]: http://svn.apache.org/repos/asf/jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/JackrabbitRepository.java
[ImpersonationCredentials]: /oak/docs/apidocs/org/apache/jackrabbit/oak/spi/security/authentication/ImpersonationCredentials.html
-[AuthInfo]: /oak/docs/apidocs/org/apache/jackrabbit/oak/spi/security/authentication/AuthInfo.html
+[AuthInfoImpl]: /oak/docs/apidocs/org/apache/jackrabbit/oak/spi/security/authentication/AuthInfoImpl.html
+[AuthInfo]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/AuthInfo.html
[GuestLoginModule]: /oak/docs/apidocs/org/apache/jackrabbit/oak/spi/security/authentication/GuestLoginModule.html
[LoginModuleImpl]: /oak/docs/apidocs/org/apache/jackrabbit/oak/security/authentication/user/LoginModuleImpl.html
[com.day.crx.security.ldap.LDAPLoginModule]: http://dev.day.com/docs/en/crx/current/administering/ldap_authentication.html
Modified: jackrabbit/oak/trunk/oak-doc/src/site/site.xml
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/site.xml?rev=1596292&r1=1596291&r2=1596292&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/site.xml (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/site.xml Tue May 20 15:35:09 2014
@@ -41,7 +41,7 @@ under the License.
<menu name="Features and Plugins">
<item href="query.html" name="Query" />
<item href="security/overview.html" name="Security" />
- <item href="blobstore.html" name="BlobStore" />
+ <item href="plugins/blobstore.html" name="BlobStore" />
<item href="clustering.html" name="Clustering" />
</menu>
<menu name="Using Oak">