diff --git a/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/config/package-info.java b/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/config/package-info.java new file mode 100644 index 00000000000..3cc6d89f2a1 --- /dev/null +++ b/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/config/package-info.java @@ -0,0 +1,73 @@ +/* + * 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. + */ +/** + * + * Jackrabbit configuration handling. + *

+ * This package contains functionality for reading and manipulating the + * Jackrabbit configuration. The configuration functionality can be + * divided in two parts: parsing and representing configuration. + * + *

Parsing configuration

+ *

+ * The configuration parsing functionality is located in the + * {@link org.apache.jackrabbit.core.config.ConfigurationParser ConfigurationParser} + * class. The parser class reads repository and workspace configuration + * files and builds corresponding configuration object structures. + *

+ *

+ * The static create() factory methods of the + * {@link org.apache.jackrabbit.core.config.RepositoryConfig RepositoryConfig} + * class are the standard ways of invoking the configuration parser. + *

+ * + *

Representating configuration

+ *

+ * The parsed configuration information is represented using Config object + * structures. The + * {@link org.apache.jackrabbit.core.config.RepositoryConfig RepositoryConfig} + * and + * {@link org.apache.jackrabbit.core.config.WorkspaceConfig WorkspaceConfig} + * classes are used for the top-level configuration. Other configuration classes + * are used according to the class diagram shown below. + * Class Diagram for Repository Configuration + *

+ * In addition to the static configuration information, some Config classes + * contain references to configured implementation objects. These implementation + * objects are not instantiated in the Config constructors to simplify + * configuration parsing. Instead the Config classes provide an + * init() method that instantiates and initializes all + * contained implementation objects. + *

+ * The + * {@link org.apache.jackrabbit.core.config.RepositoryConfig RepositoryConfig} + * class contains also a set of static and instance methods for manipulating + * the repository configuration, especially creating and loading workspace + * configurations. + * + *

Modifying configuration

+ *

+ * The configuration classes in this package are immutable to enforce the + * contract that the configuration should not be modified once it has been + * intstantiated. It is possible to subclass the configuration classes as long + * as the immutability contract is not broken. The public constructors allow + * a limited form of dynamic configurability for Jackrabbit, but note that the + * only officially supported Jackrabbit configuration interface are the XML + * configuration files. + *

+ */ +package org.apache.jackrabbit.core.config; diff --git a/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/fs/db/package-info.java b/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/fs/db/package-info.java new file mode 100644 index 00000000000..bea6477750f --- /dev/null +++ b/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/fs/db/package-info.java @@ -0,0 +1,35 @@ +/* + * 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. + */ +/** + * + * This package contains the class {@link DbFileSystem}, + * a simple generic JDBC-based FileSystem implementation + * for Jackrabbit. + *

+ * It also contains [schemaName].ddl files which are read by + * {@link DbFileSystem} in order to automatically + * create the required schema objects on the target database. Every line in a + * [schemaName].ddl file is executed separatly by calling + * java.sql.Statement.execute(String) where every occurence of the + * the string "${schemaObjectPrefix}" has been replaced with the + * value of the property schemaObjectPrefix (see + * {@link DbFileSystem#setSchemaObjectPrefix(String)}). + * The schema name is either set programmtically by calling + * {@link DbFileSystem#setSchema(String)} or configured + * through the schema bean property. + */ +package org.apache.jackrabbit.core.fs.db; diff --git a/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/package-info.java b/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/package-info.java new file mode 100644 index 00000000000..72b5e8c2cb6 --- /dev/null +++ b/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/package-info.java @@ -0,0 +1,116 @@ +/* + * 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. + */ +/** + * + * Contains the core classes that provide the implementation of the JCR API. + *

+ * The following table lists the core JCR interfaces and the corresponding + * Jackrabbit implementation classes found in this package. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
JCR interfaces and Jackrabbit implementations
JCR interfaceImplementation class
{@link javax.jcr.Repository Repository}{@link org.apache.jackrabbit.core.RepositoryImpl RepositoryImpl}
{@link javax.jcr.Session Session}{@link org.apache.jackrabbit.core.SessionImpl SessionImpl}
{@link javax.jcr.Workspace Workspace}{@link org.apache.jackrabbit.core.WorkspaceImpl WorkspaceImpl}
{@link javax.jcr.Item Item}{@link org.apache.jackrabbit.core.ItemImpl ItemImpl}
{@link javax.jcr.Property Property}{@link org.apache.jackrabbit.core.PropertyImpl PropertyImpl}
{@link javax.jcr.Node Node}{@link org.apache.jackrabbit.core.NodeImpl NodeImpl}
+ *

+ * A Jackrabbit repository instance can be created using the static + * {@link org.apache.jackrabbit.core.RepositoryImpl#create(org.apache.jackrabbit.core.config.RepositoryConfig) RepositoryImpl.create(RepositoryConfig)} + * method. Classes in the + * {@link org.apache.jackrabbit.core.jndi org.apache.jackrabbit.core.jndi} + * package provide a mechanism for binding a Jackrabbit repository in a + * JNDI directory context. + *

+ * A SessionImpl instance is created upon successfully login to the + * Repository (see Repository#login(Credentials, String)). + *

+ * A Session is always tied to the Workspace + * specified in the Repository#login(Credentials, String) call. A + * workspace represents a persistent tree of repository items (i.e. Nodes + * and Propertys). The items in a workspace are 'visible' to all + * sessions accessing it (subject to their access rights, of course). + * A WorkspaceImpl instance represents a specifc workspace as + * seen by the session that accesses it. + *

+ * Every repository item is uniquely identified by its ItemId. The id + * of a node (NodeId) consists of the node's uuid. The id of a property + * (PropertyId) consists of the parent node's uuid and the + * name of the property. + * + *

Item managers

+ *

+ * Every SessionImpl instance has its own ItemManager. + * The per-session instance of ItemManager acts as item factory (i.e. + * it creates NodeImpl and PropertyImpl instances) and + * provides item access by item id and item caching. + *

+ * The data (or state) of an item is represented by the following classes in the + * subpackage state: + *

+ *

+ * There's one SharedItemStateManager for every workspace. + * It provides item state caching and it guarantees that there's only one + * (persistent) item state instance for any distinct item id in that workspace. + *

+ * Every session has its own SessionItemStateManager that consists + * of the session's TransientItemStateManager and the workspace's + * SharedItemStateManager. + *

+ * Each item (i.e. NodeImpl and PropertyImpl) instance + * is holding an ItemState instance. When e.g. a session is modifying + * a property by changing the property's value, a new transient item state + * is created by the session's TransientItemStateManager. This + * transient state is actually wrapping the (old) shared state (copy on write). + * The PropertyImpl's state is then replaced by the new transient state. + *

+ * Transient (i.e. unsaved) modifications are 'session-local', i.e. they are not + * visible to other sessions. When the modifications are saved they become instantly + * visible to all sessions accessing the same workspace. + */ +package org.apache.jackrabbit.core; diff --git a/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/persistence/db/package-info.java b/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/persistence/db/package-info.java new file mode 100644 index 00000000000..480339977e1 --- /dev/null +++ b/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/persistence/db/package-info.java @@ -0,0 +1,34 @@ +/* + * 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. + */ +/** + * + * This package contains the class {@link SimpleDbPersistenceManager}, + * a simple generic JDBC-based PersistenceManager for Jackrabbit. + *

+ * It also contains [schemaName].ddl files which are read by + * {@link SimpleDbPersistenceManager} in order to automatically + * create the required schema objects on the target database. Every line in a + * [schemaName].ddl file is executed separatly by calling + * java.sql.Statement.execute(String) where every occurence of the + * the string "${schemaObjectPrefix}" has been replaced with the + * value of the property schemaObjectPrefix (see + * {@link SimpleDbPersistenceManager#setSchemaObjectPrefix(String)}). + * The schema name is either set programmtically by calling + * {@link SimpleDbPersistenceManager#setSchema(String)} or configured + * through the schema bean property. + */ +package org.apache.jackrabbit.core.persistence.db; diff --git a/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/version/package-info.java b/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/version/package-info.java new file mode 100644 index 00000000000..a80cb8a8849 --- /dev/null +++ b/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/version/package-info.java @@ -0,0 +1,41 @@ +/* + * 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. + */ +/** + * + * The versioning framework in jackrabbit consists of 3 layers. A persistence layer, + * an application layer and an presentation layer.

+ * The persistence layer uses a 'normal' workspace as storage. The storage can later + * be exchanged by a more scaleable one. The application layer operates on the + * persistent one and provides the internal view of the version storage. It is + * manifested through the InternalVersion and + * InternalVersionHistory objects. + * The internal versions are also mapped to the content and exposed through the + * API (i.e. the Version extends Node and can be inspected + * with normal Node methods). Furthermore the version store is also exposed below + * /jcr:system/jcr:versionStorage. The exact structure of it is not + * defined yet, so applications should not relay on it and rather use + * Node.getVersionHistory() to access a particular version history or + * use the search mechanisms to find the respective versions.

+ * The presentation layer is managed by the VersionManager. it is + * responsible for mapping the version storage to the content. + *

+ * Open issues: + *

+ */ +package org.apache.jackrabbit.core.version; diff --git a/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/config/package.html b/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/config/package.html deleted file mode 100644 index f758903f0e3..00000000000 --- a/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/config/package.html +++ /dev/null @@ -1,72 +0,0 @@ - - -Jackrabbit configuration handling. -

-This package contains functionality for reading and manipulating the -Jackrabbit configuration. The configuration functionality can be -divided in two parts: parsing and representing configuration. - -

Parsing configuration

-

-The configuration parsing functionality is located in the -{@link org.apache.jackrabbit.core.config.ConfigurationParser ConfigurationParser} -class. The parser class reads repository and workspace configuration -files and builds corresponding configuration object structures. -

-

-The static create() factory methods of the -{@link org.apache.jackrabbit.core.config.RepositoryConfig RepositoryConfig} -class are the standard ways of invoking the configuration parser. -

- -

Representating configuration

-

-The parsed configuration information is represented using Config object -structures. The -{@link org.apache.jackrabbit.core.config.RepositoryConfig RepositoryConfig} -and -{@link org.apache.jackrabbit.core.config.WorkspaceConfig WorkspaceConfig} -classes are used for the top-level configuration. Other configuration classes -are used according to the class diagram shown below. -Class Diagram for Repository Configuration -

-In addition to the static configuration information, some Config classes -contain references to configured implementation objects. These implementation -objects are not instantiated in the Config constructors to simplify -configuration parsing. Instead the Config classes provide an -init() method that instantiates and initializes all -contained implementation objects. -

-The -{@link org.apache.jackrabbit.core.config.RepositoryConfig RepositoryConfig} -class contains also a set of static and instance methods for manipulating -the repository configuration, especially creating and loading workspace -configurations. - -

Modifying configuration

-

-The configuration classes in this package are immutable to enforce the -contract that the configuration should not be modified once it has been -intstantiated. It is possible to subclass the configuration classes as long -as the immutability contract is not broken. The public constructors allow -a limited form of dynamic configurability for Jackrabbit, but note that the -only officially supported Jackrabbit configuration interface are the XML -configuration files. -

- - diff --git a/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/fs/db/package.html b/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/fs/db/package.html deleted file mode 100644 index 6617384d455..00000000000 --- a/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/fs/db/package.html +++ /dev/null @@ -1,33 +0,0 @@ - - -This package contains the class {@link DbFileSystem}, -a simple generic JDBC-based FileSystem implementation -for Jackrabbit. -

-It also contains [schemaName].ddl files which are read by -{@link DbFileSystem} in order to automatically -create the required schema objects on the target database. Every line in a -[schemaName].ddl file is executed separatly by calling -java.sql.Statement.execute(String) where every occurence of the -the string "${schemaObjectPrefix}" has been replaced with the -value of the property schemaObjectPrefix (see - {@link DbFileSystem#setSchemaObjectPrefix(String)}). -The schema name is either set programmtically by calling -{@link DbFileSystem#setSchema(String)} or configured -through the schema bean property. - diff --git a/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/package.html b/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/package.html deleted file mode 100644 index 2f3a3ba776e..00000000000 --- a/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/package.html +++ /dev/null @@ -1,114 +0,0 @@ - - -Contains the core classes that provide the implementation of the JCR API. -

-The following table lists the core JCR interfaces and the corresponding -Jackrabbit implementation classes found in this package. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
JCR interfaces and Jackrabbit implementations
JCR interfaceImplementation class
{@link javax.jcr.Repository Repository}{@link org.apache.jackrabbit.core.RepositoryImpl RepositoryImpl}
{@link javax.jcr.Session Session}{@link org.apache.jackrabbit.core.SessionImpl SessionImpl}
{@link javax.jcr.Workspace Workspace}{@link org.apache.jackrabbit.core.WorkspaceImpl WorkspaceImpl}
{@link javax.jcr.Item Item}{@link org.apache.jackrabbit.core.ItemImpl ItemImpl}
{@link javax.jcr.Property Property}{@link org.apache.jackrabbit.core.PropertyImpl PropertyImpl}
{@link javax.jcr.Node Node}{@link org.apache.jackrabbit.core.NodeImpl NodeImpl}
-

-A Jackrabbit repository instance can be created using the static -{@link org.apache.jackrabbit.core.RepositoryImpl#create(org.apache.jackrabbit.core.config.RepositoryConfig) RepositoryImpl.create(RepositoryConfig)} -method. Classes in the -{@link org.apache.jackrabbit.core.jndi org.apache.jackrabbit.core.jndi} -package provide a mechanism for binding a Jackrabbit repository in a -JNDI directory context. -

-A SessionImpl instance is created upon successfully login to the -Repository (see Repository#login(Credentials, String)). -

-A Session is always tied to the Workspace -specified in the Repository#login(Credentials, String) call. A -workspace represents a persistent tree of repository items (i.e. Nodes -and Propertys). The items in a workspace are 'visible' to all -sessions accessing it (subject to their access rights, of course). -A WorkspaceImpl instance represents a specifc workspace as -seen by the session that accesses it. -

-Every repository item is uniquely identified by its ItemId. The id -of a node (NodeId) consists of the node's uuid. The id of a property -(PropertyId) consists of the parent node's uuid and the -name of the property. - -

Item managers

-

-Every SessionImpl instance has its own ItemManager. -The per-session instance of ItemManager acts as item factory (i.e. -it creates NodeImpl and PropertyImpl instances) and -provides item access by item id and item caching. -

-The data (or state) of an item is represented by the following classes in the -subpackage state: -

-

-There's one SharedItemStateManager for every workspace. -It provides item state caching and it guarantees that there's only one -(persistent) item state instance for any distinct item id in that workspace. -

-Every session has its own SessionItemStateManager that consists -of the session's TransientItemStateManager and the workspace's -SharedItemStateManager. -

-Each item (i.e. NodeImpl and PropertyImpl) instance -is holding an ItemState instance. When e.g. a session is modifying -a property by changing the property's value, a new transient item state -is created by the session's TransientItemStateManager. This -transient state is actually wrapping the (old) shared state (copy on write). -The PropertyImpl's state is then replaced by the new transient state. -

-Transient (i.e. unsaved) modifications are 'session-local', i.e. they are not -visible to other sessions. When the modifications are saved they become instantly -visible to all sessions accessing the same workspace. - diff --git a/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/persistence/db/package.html b/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/persistence/db/package.html deleted file mode 100644 index 776db8ecab6..00000000000 --- a/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/persistence/db/package.html +++ /dev/null @@ -1,32 +0,0 @@ - - -This package contains the class {@link SimpleDbPersistenceManager}, -a simple generic JDBC-based PersistenceManager for Jackrabbit. -

-It also contains [schemaName].ddl files which are read by -{@link SimpleDbPersistenceManager} in order to automatically -create the required schema objects on the target database. Every line in a -[schemaName].ddl file is executed separatly by calling -java.sql.Statement.execute(String) where every occurence of the -the string "${schemaObjectPrefix}" has been replaced with the -value of the property schemaObjectPrefix (see - {@link SimpleDbPersistenceManager#setSchemaObjectPrefix(String)}). -The schema name is either set programmtically by calling -{@link SimpleDbPersistenceManager#setSchema(String)} or configured -through the schema bean property. - diff --git a/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/version/package.html b/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/version/package.html deleted file mode 100644 index 0a7212e8353..00000000000 --- a/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/version/package.html +++ /dev/null @@ -1,40 +0,0 @@ - - -The versioning framework in jackrabbit consists of 3 layers. A persistence layer, -an application layer and an presentation layer.

-The persistence layer uses a 'normal' workspace as storage. The storage can later -be exchanged by a more scaleable one. The application layer operates on the -persistent one and provides the internal view of the version storage. It is -manifested through the InternalVersion and -InternalVersionHistory objects. -The internal versions are also mapped to the content and exposed through the -API (i.e. the Version extends Node and can be inspected -with normal Node methods). Furthermore the version store is also exposed below -/jcr:system/jcr:versionStorage. The exact structure of it is not -defined yet, so applications should not relay on it and rather use -Node.getVersionHistory() to access a particular version history or -use the search mechanisms to find the respective versions.

-The presentation layer is managed by the VersionManager. it is -responsible for mapping the version storage to the content. -

-Open issues: -

- - diff --git a/jackrabbit-jcr-commons/src/main/java/org/apache/jackrabbit/uuid/package-info.java b/jackrabbit-jcr-commons/src/main/java/org/apache/jackrabbit/uuid/package-info.java new file mode 100644 index 00000000000..300eaeb9cbe --- /dev/null +++ b/jackrabbit-jcr-commons/src/main/java/org/apache/jackrabbit/uuid/package-info.java @@ -0,0 +1,30 @@ +/* + * 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. + */ +/** + * + *

+ * This package contains a UUID (Universally Unique Identifier) version 4 + * generator implementation copied from the + * Jakarta Commons-Id project. + *

+ *

+ * TODO: Replace with commons-id.jar as soon as official release is + * available. + *

+ */ +package org.apache.jackrabbit.uuid; diff --git a/jackrabbit-jcr-commons/src/main/javadoc/org/apache/jackrabbit/uuid/package.html b/jackrabbit-jcr-commons/src/main/javadoc/org/apache/jackrabbit/uuid/package.html deleted file mode 100644 index 507eb0ef016..00000000000 --- a/jackrabbit-jcr-commons/src/main/javadoc/org/apache/jackrabbit/uuid/package.html +++ /dev/null @@ -1,28 +0,0 @@ - - -

- This package contains a UUID (Universally Unique Identifier) version 4 - generator implementation copied from from the - Jakarta Commons-Id project. -

-

- TODO: Replace with commons-id.jar as soon as official release is - available. -

- diff --git a/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/server/io/package-info.java b/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/server/io/package-info.java new file mode 100644 index 00000000000..9fe39a6c914 --- /dev/null +++ b/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/server/io/package-info.java @@ -0,0 +1,25 @@ +/* + * + * 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. + */ + +/** + * + * The jackrabbit webdav server uses the classes defined in this package in order + * to perform import and export operations in order to respond to PUT, MKCOL, PROPPATCH + * and PROPFIND, GET, HEAD requests, respectively. + */ +package org.apache.jackrabbit.server.io; diff --git a/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/jcr/package-info.java b/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/jcr/package-info.java new file mode 100644 index 00000000000..b4a687759a1 --- /dev/null +++ b/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/jcr/package-info.java @@ -0,0 +1,23 @@ +/* + * + * 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. + */ + +/** + * + * Contains JCR specific implementations. + */ +package org.apache.jackrabbit.webdav.jcr; diff --git a/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/jcr/version/package-info.java b/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/jcr/version/package-info.java new file mode 100644 index 00000000000..2589c688707 --- /dev/null +++ b/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/jcr/version/package-info.java @@ -0,0 +1,29 @@ +/* + * + * 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. + */ + +/** + * + * Contains JCR specific implementations for the following interfaces: + * + */ +package org.apache.jackrabbit.webdav.jcr.version; diff --git a/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/jcr/version/report/package-info.java b/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/jcr/version/report/package-info.java new file mode 100644 index 00000000000..b89273049e3 --- /dev/null +++ b/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/jcr/version/report/package-info.java @@ -0,0 +1,23 @@ +/* + * + * 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. + */ + +/** + * + * Contains JCR specific reports. + */ +package org.apache.jackrabbit.webdav.jcr.version.report; diff --git a/jackrabbit-jcr-server/src/main/javadoc/org/apache/jackrabbit/server/io/package.html b/jackrabbit-jcr-server/src/main/javadoc/org/apache/jackrabbit/server/io/package.html deleted file mode 100644 index 16acab2ed83..00000000000 --- a/jackrabbit-jcr-server/src/main/javadoc/org/apache/jackrabbit/server/io/package.html +++ /dev/null @@ -1,21 +0,0 @@ - - -The jackrabbit webdav server uses the classes defined in this package in order -to perform import and export operations in order to respond to PUT, MKCOL, PROPPATCH -and PROPFIND, GET, HEAD requests, respectively. - diff --git a/jackrabbit-jcr-server/src/main/javadoc/org/apache/jackrabbit/webdav/jcr/package.html b/jackrabbit-jcr-server/src/main/javadoc/org/apache/jackrabbit/webdav/jcr/package.html deleted file mode 100644 index b4ab6d62095..00000000000 --- a/jackrabbit-jcr-server/src/main/javadoc/org/apache/jackrabbit/webdav/jcr/package.html +++ /dev/null @@ -1,19 +0,0 @@ - - -Contains JCR specific implementations. - diff --git a/jackrabbit-jcr-server/src/main/javadoc/org/apache/jackrabbit/webdav/jcr/version/package.html b/jackrabbit-jcr-server/src/main/javadoc/org/apache/jackrabbit/webdav/jcr/version/package.html deleted file mode 100644 index da7a5c7e50e..00000000000 --- a/jackrabbit-jcr-server/src/main/javadoc/org/apache/jackrabbit/webdav/jcr/version/package.html +++ /dev/null @@ -1,25 +0,0 @@ - - -Contains JCR specific implementations for the following interfaces: - - diff --git a/jackrabbit-jcr-server/src/main/javadoc/org/apache/jackrabbit/webdav/jcr/version/report/package.html b/jackrabbit-jcr-server/src/main/javadoc/org/apache/jackrabbit/webdav/jcr/version/report/package.html deleted file mode 100644 index 45f5023d7f5..00000000000 --- a/jackrabbit-jcr-server/src/main/javadoc/org/apache/jackrabbit/webdav/jcr/version/report/package.html +++ /dev/null @@ -1,19 +0,0 @@ - - -Contains JCR specific reports. - diff --git a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/client/methods/package-info.java b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/client/methods/package-info.java index b667d39c615..ae2a67d7fed 100644 --- a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/client/methods/package-info.java +++ b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/client/methods/package-info.java @@ -16,16 +16,77 @@ */ /** - * Provides classes for use with the Apache HttpClient, supporting WebDAV - * request methods. + * This package contains classes and utilities used to build a WebDAV client + * implementation. *

- * This version also contains classes for use with the obsolete "Commons - * HttpClient"; they have been marked "deprecated" and will be removed in the - * next major release. - * - * @see JCR-2406 - * @see https://hc.apache.org/httpcomponents-client-4.5.x/ + * Currently, it consists of DAV-specific extensions to the + * Jakarta Commons HttpClient, + * namely a set of methods. + * + *

How to use Jakarta Commons HttpClient

+ *

+ * Please refer to the + * tutorial + * present with Jakarta Commons HttpClient for detailed + * instructions. + * + *

Simple Example

+ *

+ * The following simple example illustrates the additional functionality exposed + * by the DavMethod which serves as basic interface for all + * WebDAV specific extensions:

+ * + * First you need to create the HostConfiguration which at least + * must define the uri pointing to your WebDAV enabled server + * 

+ * String uri = "http://your-webdav-server";
+ * HostConfiguration hostConfig = new HostConfiguration();
+ * hostConfig.setHost(uri);
+ *
+ * + * Define a HttpConnectionManager, which also is responsible + * for eventual multithreading support: + * 
+ * HttpConnectionManager connectionManager = new MultiThreadedHttpConnectionManager();
+ * HttpConnectionManagerParams params = new HttpConnectionManagerParams();
+ * int maxHostConnections = 20;
+ * params.setMaxConnectionsPerHost(hostConfig, maxHostConnections);
+ * connectionManager.setParams(params);
+ *
+ * + * Create the HttpClient object and eventually pass the Credentials: + * 
+ * HttpClient client = new HttpClient(connectionManager);
+ * client.setHostConfiguration(hostConfig);
+ * Credentials creds = new UsernamePasswordCredentials("userId", "pw");
+ * client.getState().setCredentials(AuthScope.ANY, creds);
+ *
+ * + * In order to execute a WebDAV request, choose the appropriate DavMethod. + * For example, a PROPFIND request could look as follows: + * 
+ * String propfindUri = "http://your-webdav-server/anyresource";
+ * DavMethod method = new PropFindMethod(propfindUri, DavConstants.PROPFIND_ALL_PROP, DavConstants.DEPTH_1);
+ * client.executeMethod(method);
+ *
+ * + * The DavMethod interface defines two methods that allows you to determine if the + * request was successfully executed without need to evaluate the status line and + * knowing about the required status codes: + * + * + * 
+ * method.checkSuccess();
+ *
+ * + * In case of success you can retrieve the response body in an appropriate formate + * and process it according to you needs,
+ * For a PROPFIND request use e.g. DavMethod.getResponseBodyAsMultiStatus(): + * 
+ * MultiStatus multiStatus = method.getResponseBodyAsMultiStatus();
+ *
*/ -@org.osgi.annotation.versioning.Version("2.0.0") package org.apache.jackrabbit.webdav.client.methods; diff --git a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/lock/package-info.java b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/lock/package-info.java index 3d9c106ebaa..02a2ee83c72 100644 --- a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/lock/package-info.java +++ b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/lock/package-info.java @@ -1,4 +1,5 @@ /* + * * 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. @@ -6,7 +7,7 @@ * (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 + * 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, @@ -14,5 +15,9 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@org.osgi.annotation.versioning.Version("1.0.1") + +/** + * + * Provides interfaces and classes for locking related issues. + */ package org.apache.jackrabbit.webdav.lock; diff --git a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/observation/package-info.java b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/observation/package-info.java index dec4984910b..a024e826c45 100644 --- a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/observation/package-info.java +++ b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/observation/package-info.java @@ -1,4 +1,5 @@ /* + * * 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. @@ -6,7 +7,7 @@ * (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 + * 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, @@ -14,5 +15,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@org.osgi.annotation.versioning.Version("1.1.0") + +/** + * + * Contains interfaces and classes related to observation, which is not covered + * by the WebDAV protocol. + */ package org.apache.jackrabbit.webdav.observation; diff --git a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/ordering/package-info.java b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/ordering/package-info.java index 71a8aa42e25..21432a22ea5 100644 --- a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/ordering/package-info.java +++ b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/ordering/package-info.java @@ -1,4 +1,5 @@ /* + * * 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. @@ -6,7 +7,7 @@ * (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 + * 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, @@ -14,5 +15,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@org.osgi.annotation.versioning.Version("1.0.0") + +/** + * + * Contains interfaces and classes used to cover the functionality defined by the + * RFC 3648: Web Distributed Authoring + * and Versioning (WebDAV) Ordered Collections Protocol . + */ package org.apache.jackrabbit.webdav.ordering; diff --git a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/property/package-info.java b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/property/package-info.java index ddaa801c78e..48596c39bca 100644 --- a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/property/package-info.java +++ b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/property/package-info.java @@ -1,4 +1,5 @@ /* + * * 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. @@ -6,7 +7,7 @@ * (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 + * 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, @@ -14,5 +15,9 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@org.osgi.annotation.versioning.Version("1.0.0") + +/** + * + * Interfaces and classes related to WebDAV properties. + */ package org.apache.jackrabbit.webdav.property; diff --git a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/search/package-info.java b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/search/package-info.java index 5f687980a8a..68687f9db97 100644 --- a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/search/package-info.java +++ b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/search/package-info.java @@ -1,4 +1,5 @@ /* + * * 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. @@ -6,7 +7,7 @@ * (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 + * 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, @@ -14,5 +15,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@org.osgi.annotation.versioning.Version("1.0.0") + +/** + * + * Contains interfaces and classes used to cover the functionality defined by the + * Internet + * Draft WebDAV Search. + */ package org.apache.jackrabbit.webdav.search; diff --git a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/transaction/package-info.java b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/transaction/package-info.java index fdbd51e358b..380ff4f6f13 100644 --- a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/transaction/package-info.java +++ b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/transaction/package-info.java @@ -1,4 +1,5 @@ /* + * * 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. @@ -6,7 +7,7 @@ * (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 + * 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, @@ -14,5 +15,9 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@org.osgi.annotation.versioning.Version("1.0.0") + +/** + * + * Contains interfaces and classes related to transaction locks. + */ package org.apache.jackrabbit.webdav.transaction; diff --git a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/util/package-info.java b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/util/package-info.java index 654626af4fe..bb78746be4e 100644 --- a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/util/package-info.java +++ b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/util/package-info.java @@ -1,4 +1,5 @@ /* + * * 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. @@ -6,7 +7,7 @@ * (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 + * 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, @@ -14,5 +15,9 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@org.osgi.annotation.versioning.Version("1.1.0") + +/** + * + * Common utility classes. + */ package org.apache.jackrabbit.webdav.util; diff --git a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/version/package-info.java b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/version/package-info.java index b30efa2adeb..cebe2b158a6 100644 --- a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/version/package-info.java +++ b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/version/package-info.java @@ -1,4 +1,5 @@ /* + * * 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. @@ -6,7 +7,7 @@ * (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 + * 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, @@ -14,5 +15,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@org.osgi.annotation.versioning.Version("1.0.0") + +/** + * + * Interfaces and classes used to cover functionality defined by + * RFC 3253: Versioning Extensions to WebDAV. + */ package org.apache.jackrabbit.webdav.version; diff --git a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/version/report/package-info.java b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/version/report/package-info.java index d3c3b6493e8..804240709c7 100644 --- a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/version/report/package-info.java +++ b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/version/report/package-info.java @@ -1,4 +1,5 @@ /* + * * 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. @@ -6,7 +7,7 @@ * (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 + * 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, @@ -14,5 +15,9 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@org.osgi.annotation.versioning.Version("1.1.0") + +/** + * + * Report interface and inplementation for default reports defined by RFC 3253. + */ package org.apache.jackrabbit.webdav.version.report; diff --git a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/xml/package-info.java b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/xml/package-info.java index 70c12ea510d..104ad2370f7 100644 --- a/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/xml/package-info.java +++ b/jackrabbit-webdav/src/main/java/org/apache/jackrabbit/webdav/xml/package-info.java @@ -1,4 +1,5 @@ /* + * * 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. @@ -6,7 +7,7 @@ * (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 + * 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, @@ -14,5 +15,9 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@org.osgi.annotation.versioning.Version("1.2.0") + +/** + * + * Xml utility classes. + */ package org.apache.jackrabbit.webdav.xml; diff --git a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/client/methods/package.html b/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/client/methods/package.html deleted file mode 100644 index 065218d2cf1..00000000000 --- a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/client/methods/package.html +++ /dev/null @@ -1,93 +0,0 @@ - - -

-This package contains classes and utilities used to build a WebDAV client -implementation.
-Currently it consists of DAV-specific extensions to the -Jakarta Commons HttpClient, -namely a set of methods. -

- -

-

How to use Jakarta Commons HttpClient

-Please refer to the - tutorial - present with Jakarta Commons HttpClient for detailed -instructions. -

- -

-

Simple Example

-The following simple example illustrates the additional functionality exposed - by the DavMethod which serves as basic interface for all - WebDAV specific extensions:

- -First you need to create the HostConfiguration which at least - must define the uri pointing to your WebDAV enabled server -
-    String uri = "http://your-webdav-server";
-    HostConfiguration hostConfig = new HostConfiguration();
-    hostConfig.setHost(uri);
-
- -Define a HttpConnectionManager, which also is responsible - for eventual multithreading support: -
-    HttpConnectionManager connectionManager = new MultiThreadedHttpConnectionManager();
-    HttpConnectionManagerParams params = new HttpConnectionManagerParams();
-    int maxHostConnections = 20;
-    params.setMaxConnectionsPerHost(hostConfig, maxHostConnections);
-    connectionManager.setParams(params);
-
- -Create the HttpClient object and eventually pass the Credentials: -
-    HttpClient client = new HttpClient(connectionManager);
-    client.setHostConfiguration(hostConfig);
-    Credentials creds = new UsernamePasswordCredentials("userId", "pw");
-    client.getState().setCredentials(AuthScope.ANY, creds);
-
- -In order to execute a WebDAV request, choose the appropriate DavMethod. - For example, a PROPFIND request could look as follows: -
-    String propfindUri = "http://your-webdav-server/anyresource";
-    DavMethod method = new PropFindMethod(propfindUri, DavConstants.PROPFIND_ALL_PROP, DavConstants.DEPTH_1);
-    client.executeMethod(method);
-
- -The DavMethod interface defines two methods that allows you to determine if the - request was successfully executed without need to evaluate the status line and - knowing about the required status codes: - - -
-    method.checkSuccess();
-
- -In case of success you can retrieve the response body in an appropriate formate - and process it according to you needs,
- For a PROPFIND request use e.g. DavMethod.getResponseBodyAsMultiStatus(): -
-    MultiStatus multiStatus = method.getResponseBodyAsMultiStatus();
-
-

- \ No newline at end of file diff --git a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/lock/package.html b/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/lock/package.html deleted file mode 100644 index 0c654f514f5..00000000000 --- a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/lock/package.html +++ /dev/null @@ -1,19 +0,0 @@ - - -Provides interfaces and classes for locking related issues. - diff --git a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/observation/package.html b/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/observation/package.html deleted file mode 100644 index ac8f7a86466..00000000000 --- a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/observation/package.html +++ /dev/null @@ -1,20 +0,0 @@ - - -Contains interfaces and classes related to observation, which is not covered -by the WebDAV protocol. - diff --git a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/ordering/package.html b/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/ordering/package.html deleted file mode 100644 index 9c0cb79aed1..00000000000 --- a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/ordering/package.html +++ /dev/null @@ -1,21 +0,0 @@ - - -Contains interfaces and classes used to cover the functionality defined by the -RFC 3648: Web Distributed Authoring -and Versioning (WebDAV) Ordered Collections Protocol . - diff --git a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/property/package.html b/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/property/package.html deleted file mode 100644 index 373f9f7569b..00000000000 --- a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/property/package.html +++ /dev/null @@ -1,19 +0,0 @@ - - -Interfaces and classes related to WebDAV properties. - diff --git a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/search/package.html b/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/search/package.html deleted file mode 100644 index 0dd158f1ed8..00000000000 --- a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/search/package.html +++ /dev/null @@ -1,21 +0,0 @@ - - -Contains interfaces and classes used to cover the functionality defined by the -Internet -Draft WebDAV Search. - diff --git a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/transaction/package.html b/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/transaction/package.html deleted file mode 100644 index 21b99084b8e..00000000000 --- a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/transaction/package.html +++ /dev/null @@ -1,19 +0,0 @@ - - -Contains interfaces and classes related to transaction locks. - diff --git a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/util/package.html b/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/util/package.html deleted file mode 100644 index 726174cb66c..00000000000 --- a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/util/package.html +++ /dev/null @@ -1,19 +0,0 @@ - - -Common utility classes. - diff --git a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/version/package.html b/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/version/package.html deleted file mode 100644 index 7dc29b7a564..00000000000 --- a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/version/package.html +++ /dev/null @@ -1,20 +0,0 @@ - - -Interfaces and classes used to cover functionality defined by -RFC 3253: Versioning Extensions to WebDAV. - diff --git a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/version/report/package.html b/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/version/report/package.html deleted file mode 100644 index 208d49bad74..00000000000 --- a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/version/report/package.html +++ /dev/null @@ -1,19 +0,0 @@ - - -Report interface and inplementation for default reports defined by RFC 3253. - diff --git a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/xml/package.html b/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/xml/package.html deleted file mode 100644 index 69761f08fbc..00000000000 --- a/jackrabbit-webdav/src/main/javadoc/org/apache/jackrabbit/webdav/xml/package.html +++ /dev/null @@ -1,19 +0,0 @@ - - -Xml utility classes. -