This is an automated email from the ASF dual-hosted git repository.
martin_s pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/archiva.git
The following commit(s) were added to refs/heads/master by this push:
new 15187ea Updating content item api
15187ea is described below
commit 15187ea422859c2f660f03320fc8b93911a8eef9
Author: Martin Stockhammer <[email protected]>
AuthorDate: Wed Feb 12 08:41:22 2020 +0100
Updating content item api
---
.../repository/UnsupportedConversionException.java | 45 +++++++++++
.../archiva/repository/content/Artifact.java | 27 +------
.../content/{Project.java => ContentItem.java} | 67 +++++-----------
.../apache/archiva/repository/content/Project.java | 24 +-----
.../apache/archiva/repository/content/Version.java | 23 +-----
.../content/base/ArchivaContentItem.java | 93 ++++++++++++++++++++++
.../repository/content/base/ArchivaProject.java | 78 ++++++++++++++++++
7 files changed, 240 insertions(+), 117 deletions(-)
diff --git
a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/UnsupportedConversionException.java
b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/UnsupportedConversionException.java
new file mode 100644
index 0000000..f675ea0
--- /dev/null
+++
b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/UnsupportedConversionException.java
@@ -0,0 +1,45 @@
+package org.apache.archiva.repository;
+
+/*
+ * 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.
+ */
+
+/**
+ * Thrown, if conversion to a specific class is not possible.
+ */
+public class UnsupportedConversionException extends RepositoryException
+{
+ public UnsupportedConversionException( )
+ {
+ }
+
+ public UnsupportedConversionException( String message, Throwable cause )
+ {
+ super( message, cause );
+ }
+
+ public UnsupportedConversionException( String message )
+ {
+ super( message );
+ }
+
+ public UnsupportedConversionException( Throwable cause )
+ {
+ super( cause );
+ }
+}
diff --git
a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Artifact.java
b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Artifact.java
index b2ae218..cd1f2e2 100644
---
a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Artifact.java
+++
b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Artifact.java
@@ -39,7 +39,7 @@ import java.util.Map;
*
* @author Martin Stockhammer <[email protected]>
*/
-public interface Artifact extends Comparable<Artifact>
+public interface Artifact extends ContentItem
{
/**
* The namespace is the location of the artifact.
@@ -146,30 +146,5 @@ public interface Artifact extends Comparable<Artifact>
*/
StorageAsset getAsset();
- /**
- * Returns additional attributes of the artifact. Implementations may add
additional attributes, e.g. author name
- * or creation date. Specific implementation attributes can be accessed
either by the {@link #getAttributes()} method
- * or by a specific implementation class (see {@link #adapt(Class)}. Use
via the adapter is type safe.
- *
- * @return a map of attribute key, value pairs
- */
- Map<String,String> getAttributes();
-
-
- /**
- * Returns the repository type specific implementation
- * @param clazz the specific implementation class
- * @param <T> the class or interface
- * @return the specific project implementation
- */
- <T extends Artifact> T adapt(Class<T> clazz) throws
UnsupportedRepositoryTypeException;
-
- /**
- * Returns <code>true</code>, if this project supports the given adaptor
class.
- * @param clazz the class to convert this project to
- * @param <T> the type
- * @return <code>true/code>, if the implementation is supported, otherwise
false
- */
- <T extends Artifact> boolean supports(Class<T> clazz);
}
diff --git
a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Project.java
b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/ContentItem.java
similarity index 55%
copy from
archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Project.java
copy to
archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/ContentItem.java
index d52339d..ec9fca6 100644
---
a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Project.java
+++
b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/ContentItem.java
@@ -9,7 +9,7 @@ package org.apache.archiva.repository.content;
* "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
@@ -19,61 +19,19 @@ package org.apache.archiva.repository.content;
* under the License.
*/
-import org.apache.archiva.repository.RepositoryContent;
-import org.apache.archiva.repository.UnsupportedRepositoryTypeException;
+import org.apache.archiva.repository.UnsupportedConversionException;
import java.util.Map;
-/**
- *
- * The project is the container for several versions each with different
artifacts.
- *
- * <pre>
- * project +--> version 1 + -> artifact 1
- * | |
- * | + -> artifact 2
- * |
- * +--> version 2 ----> artifact 3
- * </pre>
- *
- * Implementations must provide proper hash and equals methods.
- *
- * @author Martin Stockhammer <[email protected]>
- */
-public interface Project extends Comparable<Project>
+public interface ContentItem
{
-
- /**
- * The namespace of the project
- * @return the namespace
- */
- String getNamespace();
-
- /**
- * The id of the project
- * @return the project id
- */
- String getId();
-
- /**
- * The repository this project is part of.
- * @return the repository content
- */
- RepositoryContent getRepository();
-
- /**
- * Additional attributes
- * @return the additional attributes
- */
- Map<String, String> getAttributes();
-
/**
* Returns the repository type specific implementation
* @param clazz the specific implementation class
* @param <T> the class or interface
* @return the specific project implementation
*/
- <T extends Project> T adapt(Class<T> clazz) throws
UnsupportedRepositoryTypeException;
+ <T extends Project> T adapt( Class<T> clazz ) throws
UnsupportedConversionException;
/**
* Returns <code>true</code>, if this project supports the given adaptor
class.
@@ -81,5 +39,20 @@ public interface Project extends Comparable<Project>
* @param <T> the type
* @return <code>true/code>, if the implementation is supported, otherwise
false
*/
- <T extends Project> boolean supports(Class<T> clazz);
+ <T extends Project> boolean supports( Class<T> clazz );
+
+ /**
+ * Additional attributes
+ * @return the additional attributes
+ */
+ Map<String, String> getAttributes( );
+
+ /**
+ * Returns the attribute value for the given key.
+ *
+ * @param key the attribute key
+ * @return the value, if the key exists, otherwise <code>null</code>
+ *
+ */
+ String getAttribute( String key );
}
diff --git
a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Project.java
b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Project.java
index d52339d..2ad2c88 100644
---
a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Project.java
+++
b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Project.java
@@ -20,6 +20,7 @@ package org.apache.archiva.repository.content;
*/
import org.apache.archiva.repository.RepositoryContent;
+import org.apache.archiva.repository.UnsupportedConversionException;
import org.apache.archiva.repository.UnsupportedRepositoryTypeException;
import java.util.Map;
@@ -40,7 +41,7 @@ import java.util.Map;
*
* @author Martin Stockhammer <[email protected]>
*/
-public interface Project extends Comparable<Project>
+public interface Project extends ContentItem
{
/**
@@ -61,25 +62,4 @@ public interface Project extends Comparable<Project>
*/
RepositoryContent getRepository();
- /**
- * Additional attributes
- * @return the additional attributes
- */
- Map<String, String> getAttributes();
-
- /**
- * Returns the repository type specific implementation
- * @param clazz the specific implementation class
- * @param <T> the class or interface
- * @return the specific project implementation
- */
- <T extends Project> T adapt(Class<T> clazz) throws
UnsupportedRepositoryTypeException;
-
- /**
- * Returns <code>true</code>, if this project supports the given adaptor
class.
- * @param clazz the class to convert this project to
- * @param <T> the type
- * @return <code>true/code>, if the implementation is supported, otherwise
false
- */
- <T extends Project> boolean supports(Class<T> clazz);
}
diff --git
a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Version.java
b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Version.java
index 6c17dee..0114939 100644
---
a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Version.java
+++
b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Version.java
@@ -32,7 +32,7 @@ import java.util.Map;
*
* @author Martin Stockhammer <[email protected]>
*/
-public interface Version extends Comparable<Version>
+public interface Version extends ContentItem
{
/**
* Returns the version string.
@@ -55,26 +55,5 @@ public interface Version extends Comparable<Version>
*/
Project getProject();
- /**
- * Returns additional attributes.
- * @return the map of attribute key, value pairs
- */
- Map<String,String> getAttributes();
-
- /**
- * Returns the repository type specific implementation
- * @param clazz the specific implementation class
- * @param <T> the class or interface
- * @return the specific project implementation
- */
- <T extends Project> T adapt(Class<T> clazz) throws
UnsupportedRepositoryTypeException;
-
- /**
- * Returns <code>true</code>, if this project supports the given adaptor
class.
- * @param clazz the class to convert this project to
- * @param <T> the type
- * @return <code>true/code>, if the implementation is supported, otherwise
false
- */
- <T extends Project> boolean supports(Class<T> clazz);
}
diff --git
a/archiva-modules/archiva-base/archiva-repository-layer/src/main/java/org/apache/archiva/repository/content/base/ArchivaContentItem.java
b/archiva-modules/archiva-base/archiva-repository-layer/src/main/java/org/apache/archiva/repository/content/base/ArchivaContentItem.java
new file mode 100644
index 0000000..b538bb1
--- /dev/null
+++
b/archiva-modules/archiva-base/archiva-repository-layer/src/main/java/org/apache/archiva/repository/content/base/ArchivaContentItem.java
@@ -0,0 +1,93 @@
+package org.apache.archiva.repository.content.base;
+
+/*
+ * 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.
+ */
+
+import org.apache.archiva.repository.UnsupportedConversionException;
+import org.apache.archiva.repository.content.ContentItem;
+import org.apache.archiva.repository.content.Project;
+import org.apache.commons.lang3.StringUtils;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Abstract implementation of ContentItem interface.
+ *
+ * The attribute map is created, when the first values are put to the map.
+ *
+ */
+public abstract class ArchivaContentItem implements ContentItem
+{
+
+ private Map<String, String> attributes;
+
+ @Override
+ public abstract <T extends Project> T adapt( Class<T> clazz ) throws
UnsupportedConversionException;
+
+ @Override
+ public abstract <T extends Project> boolean supports( Class<T> clazz );
+
+
+ /**
+ * Does lazy initialization of the attributes map.
+ * Returns a unmodifiable map.
+ *
+ * @return unmodifiable map of attributes
+ */
+ @Override
+ public Map<String, String> getAttributes( )
+ {
+ if (this.attributes==null) {
+ return Collections.emptyMap( );
+ } else
+ {
+ return Collections.unmodifiableMap( this.attributes );
+ }
+ }
+
+ /**
+ * Adds a attribute value. The key must not be <code>null</code>.
+ *
+ * @param key the attribute key
+ * @param value the attribute value
+ * @throws IllegalArgumentException if the key is <code>null</code> or
empty
+ */
+ public void putAttribute(String key, String value) throws
IllegalArgumentException {
+ if (this.attributes==null) {
+ this.attributes = new HashMap<>( );
+ }
+ if ( StringUtils.isEmpty( key ) ) {
+ throw new IllegalArgumentException( "Key value must not be empty
or null" );
+ }
+ this.attributes.put( key, value );
+ }
+
+ @Override
+ public String getAttribute( String key )
+ {
+ if (this.attributes==null) {
+ return null;
+ } else
+ {
+ return this.attributes.get( key );
+ }
+ }
+}
diff --git
a/archiva-modules/archiva-base/archiva-repository-layer/src/main/java/org/apache/archiva/repository/content/base/ArchivaProject.java
b/archiva-modules/archiva-base/archiva-repository-layer/src/main/java/org/apache/archiva/repository/content/base/ArchivaProject.java
new file mode 100644
index 0000000..b2879b6
--- /dev/null
+++
b/archiva-modules/archiva-base/archiva-repository-layer/src/main/java/org/apache/archiva/repository/content/base/ArchivaProject.java
@@ -0,0 +1,78 @@
+package org.apache.archiva.repository.content.base;
+
+/*
+ * 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.
+ */
+
+import org.apache.archiva.repository.RepositoryContent;
+import org.apache.archiva.repository.UnsupportedConversionException;
+import org.apache.archiva.repository.content.Project;
+
+import java.util.Map;
+
+/**
+ * Immutable class, that represents a project.
+ */
+public class ArchivaProject extends ArchivaContentItem implements Project
+{
+ String namespace;
+ String id;
+ RepositoryContent repositoryContent;
+ Map<String, String> attributes;
+
+
+ @Override
+ public String getNamespace( )
+ {
+ return null;
+ }
+
+ @Override
+ public String getId( )
+ {
+ return null;
+ }
+
+ @Override
+ public RepositoryContent getRepository( )
+ {
+ return null;
+ }
+
+ @Override
+ public Map<String, String> getAttributes( )
+ {
+ return null;
+ }
+
+ @Override
+ public <T extends Project> T adapt( Class<T> clazz ) throws
UnsupportedConversionException
+ {
+ if (clazz != ArchivaProject.class) {
+ throw new UnsupportedConversionException( "Cannot convert to
class: " + clazz );
+ } else {
+ return (T) this;
+ }
+ }
+
+ @Override
+ public <T extends Project> boolean supports( Class<T> clazz )
+ {
+ return false;
+ }
+}
