[maven-release-plugin] copy for tag cocoon-block-deployment-1.1.0
git-svn-id: https://svn.apache.org/repos/asf/cocoon/tags/cocoon-block-deployment@761915 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/cocoon-block-deployment-1.1.0/LICENSE.txt b/cocoon-block-deployment-1.1.0/LICENSE.txt
new file mode 100644
index 0000000..261eeb9
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/LICENSE.txt
@@ -0,0 +1,201 @@
+ 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 [yyyy] [name of copyright owner]
+
+ 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/cocoon-block-deployment-1.1.0/NOTICE.txt b/cocoon-block-deployment-1.1.0/NOTICE.txt
new file mode 100644
index 0000000..bb0f11b
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/NOTICE.txt
@@ -0,0 +1,5 @@
+Apache Cocoon
+Copyright 1999-2008 The Apache Software Foundation.
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
diff --git a/cocoon-block-deployment-1.1.0/pom.xml b/cocoon-block-deployment-1.1.0/pom.xml
new file mode 100644
index 0000000..7798c8b
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/pom.xml
@@ -0,0 +1,170 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+ -->
+<!-- $Id$ -->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+ <modelVersion>4.0.0</modelVersion>
+ <packaging>jar</packaging>
+
+ <parent>
+ <groupId>org.apache.cocoon</groupId>
+ <artifactId>cocoon</artifactId>
+ <version>8</version>
+ <relativePath>../../parent/pom.xml</relativePath>
+ </parent>
+
+ <artifactId>cocoon-block-deployment</artifactId>
+ <version>1.1.0</version>
+ <name>Cocoon Block Deployment</name>
+ <description>Deployment utilities for Cocoon Blocks.</description>
+ <url>http://cocoon.apache.org/${docs.m.block-deployment.relPath}</url>
+
+ <properties>
+ <docs.name>${project.name}</docs.name>
+ <docs.version>${docs.m.block-deployment.version}</docs.version>
+ <docs.urlRelativizer>../../../</docs.urlRelativizer>
+ </properties>
+
+ <distributionManagement>
+ <site>
+ <id>website</id>
+ <url>${docs.deploymentBaseUrl}/${docs.m.block-deployment.relPath}</url>
+ </site>
+ </distributionManagement>
+
+ <dependencies>
+ <dependency>
+ <groupId>commons-io</groupId>
+ <artifactId>commons-io</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>commons-logging</groupId>
+ <artifactId>commons-logging</artifactId>
+ <exclusions>
+ <exclusion>
+ <artifactId>logkit</artifactId>
+ <groupId>logkit</groupId>
+ </exclusion>
+ <exclusion>
+ <artifactId>avalon-framework</artifactId>
+ <groupId>avalon-framework</groupId>
+ </exclusion>
+ </exclusions>
+ </dependency>
+ <dependency>
+ <groupId>org.springframework</groupId>
+ <artifactId>spring-core</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.springframework</groupId>
+ <artifactId>spring-beans</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.springframework</groupId>
+ <artifactId>spring-context</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.springframework</groupId>
+ <artifactId>spring-web</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>javax.servlet</groupId>
+ <artifactId>servlet-api</artifactId>
+ <scope>provided</scope>
+ </dependency>
+
+ <!-- Test dependencies -->
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-release-plugin</artifactId>
+ <configuration>
+ <tagBase>https://svn.apache.org/repos/asf/cocoon/tags/${project.artifactId}</tagBase>
+ </configuration>
+ </plugin>
+ </plugins>
+ <resources>
+ <resource>
+ <directory>src/main/resources</directory>
+ <filtering>true</filtering>
+ </resource>
+ <resource>
+ <directory>.</directory>
+ <targetPath>META-INF</targetPath>
+ <includes>
+ <include>LICENSE.txt</include>
+ <include>NOTICE.txt</include>
+ </includes>
+ </resource>
+ </resources>
+ </build>
+
+ <reporting>
+ <plugins>
+ <plugin>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <version>2.0.1</version>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <report>project-team</report>
+ <report>dependencies</report>
+ <report>license</report>
+ <report>summary</report>
+ <report>index</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ </reporting>
+
+ <profiles>
+ <profile>
+ <id>daisy</id>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.daisycms</groupId>
+ <artifactId>daisy-maven-plugin</artifactId>
+ <configuration>
+ <navDocId>1473</navDocId>
+ <collection>cdocs-block-deployment</collection>
+ <skipFirstNavigationDocumentLevel>false</skipFirstNavigationDocumentLevel>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ </profiles>
+
+ <scm>
+ <connection>scm:svn:https://svn.apache.org/repos/asf/cocoon/tags/cocoon-block-deployment/cocoon-block-deployment-1.1.0</connection>
+ <developerConnection>scm:svn:https://svn.apache.org/repos/asf/cocoon/tags/cocoon-block-deployment/cocoon-block-deployment-1.1.0</developerConnection>
+ <url>https://svn.apache.org/repos/asf/cocoon/tags/cocoon-block-deployment/cocoon-block-deployment-1.1.0</url>
+ </scm>
+</project>
diff --git a/cocoon-block-deployment-1.1.0/src/changes/changes.xml b/cocoon-block-deployment-1.1.0/src/changes/changes.xml
new file mode 100644
index 0000000..9e7ee35
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/src/changes/changes.xml
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+-->
+<!--
+ - See http://maven.apache.org/plugins/maven-changes-plugin/usage.html
+ -
+ - $Id$
+-->
+<document>
+ <properties>
+ <title>Changes Cocoon Block-Deployment</title>
+ </properties>
+ <body>
+ <release version="1.1.0-SNAPSHOT" date="2008-??-??">
+ <action dev="reinhard" type="add">
+ Throw BlockContextInitializationException if there are no deployed blocks but the block context protocol is used.
+ </action>
+ <action dev="reinhard" type="update">
+ Use Java 5 language features.
+ </action>
+ <action dev="reinhard" type="add">
+ The blockcontext: URLConnection checks if a requested block is available. Otherwise
+ an exception, that explains what has gone wrong, is thrown.
+ </action>
+ <action dev="gkossakowski" type="add">
+ Added implementation of org.apache.cocoon.spring.configurator.BlockResourcesHolder interface to
+ restore back-compatiblity with Cocoon Core 2.2.
+ </action>
+ <action dev="gkossakowski" type="remove">
+ Deprecated org.apache.cocoon.spring.configurator.BlockResourcesHolder interface, use
+ org.apache.cocoon.blockdeployment.BlockResourcesHolder instead. (The interface will be removed in version 1.3.x or 2.x).
+ </action>
+ </release>
+ <release version="1.0.0" date="2008-08-09" description="released">
+ <action dev="gkossakowski" type="update">
+ Java 5 as minimum requirement.
+ </action>
+ <action dev="reinhard" type="add">
+ Initial creation.
+ </action>
+ </release>
+ </body>
+</document>
diff --git a/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockContextInitializationException.java b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockContextInitializationException.java
new file mode 100644
index 0000000..6c2635d
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockContextInitializationException.java
@@ -0,0 +1,26 @@
+/*
+ * 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.
+ */
+package org.apache.cocoon.blockdeployment;
+
+public class BlockContextInitializationException extends RuntimeException {
+
+ private static final long serialVersionUID = 1L;
+
+ public BlockContextInitializationException(String message) {
+ super(message);
+ }
+}
diff --git a/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockContextURLConnection.java b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockContextURLConnection.java
new file mode 100644
index 0000000..854df3c
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockContextURLConnection.java
@@ -0,0 +1,98 @@
+/*
+ * 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.
+ */
+package org.apache.cocoon.blockdeployment;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.net.URLConnection;
+import java.util.Map;
+
+public class BlockContextURLConnection extends URLConnection {
+
+ private final Map<String, String> blockContexts;
+
+ private URLConnection urlConnection;
+
+ protected BlockContextURLConnection(URL url, Map<String, String> blockContexts) {
+ super(url);
+
+ // check if there the BlockContext map is not null.
+ // This null check can't be done earlier because in development
+ // environments, the cocoon-block-deployment library is available, but
+ // you don't necessarily use the blockcontext protocol.
+ if (blockContexts == null) {
+ throw new BlockContextInitializationException("There are no block contexts available. Make sure that the "
+ + BlockDeploymentServletContextListener.class.getName()
+ + " is configured correctly in the web.xml.");
+ }
+ this.blockContexts = blockContexts;
+ this.url = url;
+ }
+
+ @Override
+ public void connect() throws IOException {
+ this.getConnection().connect();
+ }
+
+ @Override
+ public InputStream getInputStream() throws IOException {
+ return this.getConnection().getInputStream();
+ }
+
+ private URLConnection getConnection() {
+ if (this.urlConnection == null) {
+ URL resolvedPath = null;
+ String location = this.url.toExternalForm();
+
+ // Remove the protocol and the first '/'
+ int pos = location.indexOf(":/");
+ String path = location.substring(pos + 2);
+
+ pos = path.indexOf('/');
+ if (pos != -1) {
+ // extract the block name and get the block context path
+ String blockName = path.substring(0, pos);
+ path = path.substring(pos + 1);
+ String blockContext = this.blockContexts.get(blockName);
+
+ if (blockContext == null) {
+ throw new RuntimeException("There is no block '" + blockName
+ + "' deployed. The available blocks are " + this.blockContexts + ".");
+ }
+
+ try {
+ resolvedPath = new URL(new URL(blockContext), path);
+ this.urlConnection = resolvedPath.openConnection();
+ } catch (IOException e) {
+ throw new RuntimeException("Can create URL for '" + blockContext + path + "'.'");
+ }
+ } else {
+ throw new RuntimeException("The block name part of a block context uri must end with a '/' in "
+ + location);
+ }
+ }
+ return this.urlConnection;
+ }
+
+ @Override
+ public long getLastModified() {
+ return this.getConnection().getLastModified();
+ }
+}
diff --git a/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockContextURLStreamHandler.java b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockContextURLStreamHandler.java
new file mode 100644
index 0000000..cb20cd4
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockContextURLStreamHandler.java
@@ -0,0 +1,40 @@
+/*
+ * 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.
+ */
+package org.apache.cocoon.blockdeployment;
+
+import java.io.IOException;
+import java.net.URL;
+import java.net.URLConnection;
+import java.net.URLStreamHandler;
+import java.util.Map;
+
+public class BlockContextURLStreamHandler extends URLStreamHandler {
+
+ private final Map<String, String> blockContexts;
+
+ public BlockContextURLStreamHandler(Map<String, String> blockContexts) {
+ this.blockContexts = blockContexts;
+ }
+
+ @Override
+ protected URLConnection openConnection(URL url) throws IOException {
+ return new BlockContextURLConnection(url, this.blockContexts);
+ }
+
+}
diff --git a/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockContextURLStreamHandlerFactory.java b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockContextURLStreamHandlerFactory.java
new file mode 100644
index 0000000..459e17e
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockContextURLStreamHandlerFactory.java
@@ -0,0 +1,61 @@
+/*
+ * 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.
+ */
+package org.apache.cocoon.blockdeployment;
+
+import java.net.URLStreamHandler;
+import java.net.URLStreamHandlerFactory;
+import java.util.Map;
+
+import javax.servlet.ServletContext;
+
+import org.springframework.beans.BeansException;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+import org.springframework.web.context.WebApplicationContext;
+
+public class BlockContextURLStreamHandlerFactory implements URLStreamHandlerFactory, ApplicationContextAware {
+
+ private Map<String, String> blockContexts;
+
+ /**
+ * {@inheritDoc}
+ *
+ * @see java.net.URLStreamHandlerFactory#createURLStreamHandler(java.lang.String)
+ */
+ public URLStreamHandler createURLStreamHandler(String protocol) {
+ if ("blockcontext".equalsIgnoreCase(protocol)) {
+ return new BlockContextURLStreamHandler(this.blockContexts);
+ }
+
+ return null;
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * @see org.springframework.context.ApplicationContextAware#setApplicationContext(org.springframework.context.ApplicationContext)
+ */
+ @SuppressWarnings("unchecked")
+ public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
+ WebApplicationContext webApplicationContext = (WebApplicationContext) applicationContext;
+ ServletContext servletContext = webApplicationContext.getServletContext();
+ this.blockContexts = (Map<String, String>) servletContext
+ .getAttribute(BlockDeploymentServletContextListener.BLOCK_CONTEXT_MAP);
+ }
+}
diff --git a/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockDeploymentServletContextListener.java b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockDeploymentServletContextListener.java
new file mode 100644
index 0000000..8e2fa16
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockDeploymentServletContextListener.java
@@ -0,0 +1,58 @@
+/*
+ * 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.
+ */
+package org.apache.cocoon.blockdeployment;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.Map;
+
+import javax.servlet.ServletContext;
+import javax.servlet.ServletContextEvent;
+import javax.servlet.ServletContextListener;
+
+public class BlockDeploymentServletContextListener implements ServletContextListener {
+
+ public static final String BLOCK_CONTEXT_MAP = BlockDeploymentServletContextListener.class.getName() + "/"
+ + "block-context-map";
+
+ public void contextInitialized(ServletContextEvent sce) {
+ try {
+ ServletContext servletContext = sce.getServletContext();
+
+ Map<String, String> blocks = DeploymentUtil.deployBlockArtifacts(this.getWorkdir(servletContext)
+ .getAbsolutePath());
+ servletContext.setAttribute(BLOCK_CONTEXT_MAP, blocks);
+ } catch (IOException e) {
+ throw new RuntimeException("The available Cocoon blocks can't be deployed.", e);
+ }
+ }
+
+ public void contextDestroyed(ServletContextEvent sce) {
+ sce.getServletContext().removeAttribute(BLOCK_CONTEXT_MAP);
+ }
+
+ private File getWorkdir(ServletContext servletContext) {
+ File workdir = (File) servletContext.getAttribute("javax.servlet.context.tempdir");
+ if (workdir == null) {
+ workdir = new File("cocoon-files");
+ }
+
+ return workdir;
+ }
+}
diff --git a/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockResourcesHolder.java b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockResourcesHolder.java
new file mode 100644
index 0000000..eb8dc1a
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/BlockResourcesHolder.java
@@ -0,0 +1,37 @@
+/*
+ * 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.
+ */
+package org.apache.cocoon.blockdeployment;
+
+import java.util.Map;
+
+/**
+ * This component provides a map with the deployed block resources.
+ *
+ * @version $Id: BlockResourcesHolder.java 686263 2008-08-15 15:53:47Z
+ * gkossakowski $
+ * @since 1.1.0
+ */
+public interface BlockResourcesHolder {
+
+ /**
+ * Return a map with deployed block names as keys and the url of the
+ * deployed resources as value.
+ *
+ * @return The map with the block contexts.
+ */
+ Map<String, String> getBlockContexts();
+}
diff --git a/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/DefaultBlockResourcesHolder.java b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/DefaultBlockResourcesHolder.java
new file mode 100644
index 0000000..dcc2c00
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/DefaultBlockResourcesHolder.java
@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+package org.apache.cocoon.blockdeployment;
+
+import java.util.Map;
+
+import javax.servlet.ServletContext;
+
+@SuppressWarnings("deprecation")
+public class DefaultBlockResourcesHolder implements BlockResourcesHolder,
+ org.apache.cocoon.spring.configurator.BlockResourcesHolder {
+
+ ServletContext servletContext;
+
+ @SuppressWarnings("unchecked")
+ public Map<String, String> getBlockContexts() {
+ return (Map<String, String>) this.servletContext
+ .getAttribute(BlockDeploymentServletContextListener.BLOCK_CONTEXT_MAP);
+ }
+
+ public ServletContext getServletContext() {
+ return this.servletContext;
+ }
+
+ public void setServletContext(ServletContext servletContext) {
+ this.servletContext = servletContext;
+ }
+}
diff --git a/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/DeploymentUtil.java b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/DeploymentUtil.java
new file mode 100644
index 0000000..27fefb4
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/blockdeployment/DeploymentUtil.java
@@ -0,0 +1,181 @@
+/*
+ * 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.
+ */
+package org.apache.cocoon.blockdeployment;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.JarURLConnection;
+import java.net.URL;
+import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.jar.JarEntry;
+import java.util.jar.JarFile;
+import java.util.zip.ZipEntry;
+
+import org.apache.commons.io.IOUtils;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
+/**
+ * Helper class for deploying resources from the block artifacts.
+ *
+ * @version $Id$
+ * @since 1.0
+ */
+public abstract class DeploymentUtil {
+
+ protected static final Log logger = LogFactory.getLog(DeploymentUtil.class);
+
+ protected static final String BLOCK_RESOURCES_PATH = "COB-INF";
+
+ /**
+ * Deploy all files with a given prefix from a jar file to a directory in
+ * the file system.
+ *
+ * @param jarFile The jar file containing the resources.
+ * @param prefix The common prefix for the files.
+ * @param destination The destination directory.
+ * @throws IOException
+ */
+ public static void deploy(JarFile jarFile, String prefix, String destination) throws IOException {
+ if (logger.isDebugEnabled()) {
+ logger.debug("Deploying jar " + jarFile + " to " + destination);
+ }
+ // FIXME - We should check if a deployment is required
+ final Enumeration<JarEntry> entries = jarFile.entries();
+ while (entries.hasMoreElements()) {
+ final ZipEntry entry = entries.nextElement();
+ if (!entry.isDirectory() && entry.getName().startsWith(prefix)) {
+ final String fileName = destination + entry.getName().substring(prefix.length());
+ final File out = new File(fileName);
+ // create directory
+ out.getParentFile().mkdirs();
+
+ InputStream inStream = null;
+ OutputStream outStream = null;
+ try {
+ inStream = jarFile.getInputStream(entry);
+ outStream = new FileOutputStream(out);
+ IOUtils.copy(inStream, outStream);
+ } finally {
+ if (outStream != null) {
+ outStream.close();
+ }
+ if (inStream != null) {
+ inStream.close();
+ }
+ }
+ }
+ }
+ }
+
+ protected static void deployBlockResources(String relativeDirectory, String destinationDirectory,
+ Map<String, String> blockContexts) throws IOException {
+ final Enumeration<URL> jarUrls = DeploymentUtil.class.getClassLoader().getResources(BLOCK_RESOURCES_PATH);
+ while (jarUrls.hasMoreElements()) {
+ final URL resourceUrl = jarUrls.nextElement();
+
+ String url = resourceUrl.toExternalForm();
+ if ("file".equals(resourceUrl.getProtocol())) {
+ // FIXME: This only covers the siuation when the project is
+ // Maven generated if this is a file url generated by the Maven,
+ // it has this form
+ // "file:{url}/{blockname}/target/classes/COB-INF
+ int pos = url.indexOf("/target/classes/COB-INF");
+ // extract block name (if any)
+ if (pos >= 0) {
+ String blockName = url.substring(0, pos);
+ blockName = blockName.substring(blockName.lastIndexOf('/') + 1);
+ // register the root URL for the block resources
+ blockContexts.put(blockName, url);
+ }
+ } else if ("jar".equals(resourceUrl.getProtocol()) || "zip".equals(resourceUrl.getProtocol())) {
+ // if this is a jar url, it has this form:
+ // "jar:{url-to-jar}!/{resource-path}"
+ // to open the jar, we can simply remove everything after "!/"
+ int pos = url.indexOf('!');
+ url = url.substring(0, pos + 2); // +2 as we include "!/"
+
+ // Included because of Weblogic 9.2 classloader behaviour
+ if ("zip".equals(resourceUrl.getProtocol())) {
+ url = url.replaceAll("zip:", "jar:file:");
+ }
+ final URL jarUrl = new URL(url);
+
+ final JarURLConnection connection = (JarURLConnection) jarUrl.openConnection();
+ final JarFile jarFile = connection.getJarFile();
+ String blockName = jarFile.getManifest().getMainAttributes().getValue("Cocoon-Block-Name");
+ if (blockName == null) {
+ String jarPath = jarFile.getName();
+ // extract jar name
+ String jarName = jarPath.substring(jarPath.lastIndexOf(File.separatorChar) + 1);
+ // drop file extension
+ blockName = jarName.substring(0, jarName.lastIndexOf('.'));
+ // TODO how do we strip version from blockName?
+ }
+ final StringBuffer buffer = new StringBuffer(destinationDirectory);
+ buffer.append(File.separatorChar);
+ buffer.append(relativeDirectory);
+ buffer.append(File.separatorChar);
+ buffer.append(blockName);
+ String destination = buffer.toString();
+ deploy(jarFile, BLOCK_RESOURCES_PATH, destination);
+ // register the root URL for the block resources
+ blockContexts.put(blockName, new File(destination).toURI().toURL().toExternalForm());
+ }
+ // we only handle jar files and ordinary files
+ // TODO - Should we throw an exception if it's some other protocol
+ // type? (or log?)
+ }
+ }
+
+ public static Map<String, String> deployBlockArtifacts(String destinationDirectory) throws IOException {
+ if (destinationDirectory == null) {
+ throw new IllegalArgumentException("Destination directory must not be null.");
+ }
+ final Map<String, String> blockContexts = new HashMap<String, String>();
+ // deploy all artifacts containing block resources
+ deployBlockResources("blocks", destinationDirectory, blockContexts);
+
+ return blockContexts;
+ }
+
+ public static void deployJarResources(String pattern, String destinationDirectory) throws IOException {
+ final Enumeration<URL> jarUrls = DeploymentUtil.class.getClassLoader().getResources(pattern);
+ while (jarUrls.hasMoreElements()) {
+ final URL resourceUrl = jarUrls.nextElement();
+
+ String url = resourceUrl.toExternalForm();
+ // we only handle jars!
+ if ("jar".equals(resourceUrl.getProtocol())) {
+ // if this is a jar url, it has this form:
+ // "jar:{url-to-jar}!/{resource-path}"
+ // to open the jar, we can simply remove everything after "!/"
+ int pos = url.indexOf('!');
+ url = url.substring(0, pos + 2); // +2 as we include "!/"
+ final URL jarUrl = new URL(url);
+ final JarURLConnection connection = (JarURLConnection) jarUrl.openConnection();
+ final JarFile jarFile = connection.getJarFile();
+ deploy(jarFile, pattern, destinationDirectory);
+ }
+ }
+ }
+}
diff --git a/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/spring/configurator/BlockResourcesHolder.java b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/spring/configurator/BlockResourcesHolder.java
new file mode 100644
index 0000000..7ea7021
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/src/main/java/org/apache/cocoon/spring/configurator/BlockResourcesHolder.java
@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+package org.apache.cocoon.spring.configurator;
+
+import java.util.Map;
+
+/**
+ * This component provides a map with the deployed block resources.
+ *
+ * @version $Id: BlockResourcesHolder.java 686263 2008-08-15 15:53:47Z
+ * gkossakowski $
+ * @since 1.0
+ * @deprecated Use
+ * {@link org.apache.cocoon.blockdeployment.BlockResourcesHolder}
+ * instead.
+ */
+@Deprecated
+public interface BlockResourcesHolder {
+
+ /**
+ * Return a map with deployed block names as keys and the url of the
+ * deployed resources as value.
+ *
+ * @return The map with the block contexts.
+ */
+ @SuppressWarnings("unchecked")
+ Map getBlockContexts();
+}
diff --git a/cocoon-block-deployment-1.1.0/src/main/resources/META-INF/cocoon/spring/cocoon-blockdeployment-protocol.xml b/cocoon-block-deployment-1.1.0/src/main/resources/META-INF/cocoon/spring/cocoon-blockdeployment-protocol.xml
new file mode 100644
index 0000000..9d1d71c
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/src/main/resources/META-INF/cocoon/spring/cocoon-blockdeployment-protocol.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+-->
+<!-- $Id$ -->
+<beans xmlns="http://www.springframework.org/schema/beans"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
+
+ <bean name="org.apache.cocoon.blockdeployment.BlockContextURLStreamHandlerFactory"
+ class="org.apache.cocoon.blockdeployment.BlockContextURLStreamHandlerFactory" />
+
+</beans>
diff --git a/cocoon-block-deployment-1.1.0/src/main/resources/META-INF/cocoon/spring/cocoon-blockdeployment-resourcesholder.xml b/cocoon-block-deployment-1.1.0/src/main/resources/META-INF/cocoon/spring/cocoon-blockdeployment-resourcesholder.xml
new file mode 100644
index 0000000..89696ef
--- /dev/null
+++ b/cocoon-block-deployment-1.1.0/src/main/resources/META-INF/cocoon/spring/cocoon-blockdeployment-resourcesholder.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+-->
+<!-- $Id$ -->
+<beans xmlns="http://www.springframework.org/schema/beans"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
+
+ <bean name="org.apache.cocoon.blockdeployment.BlockResourcesHolder"
+ class="org.apache.cocoon.blockdeployment.DefaultBlockResourcesHolder">
+ <property name="servletContext" ref="javax.servlet.ServletContext"/>
+ </bean>
+
+ <!-- This bean is deprecated and is kept for back-compatiblity with Cocoon Core 2.2 -->
+ <bean name="org.apache.cocoon.spring.configurator.BlockResourcesHolder"
+ class="org.apache.cocoon.blockdeployment.DefaultBlockResourcesHolder">
+ <property name="servletContext" ref="javax.servlet.ServletContext"/>
+ </bean>
+
+</beans>
