org.apache.archiva.repository

Interface RepositoryRequestInfo

All Known Implementing Classes:

MavenRepositoryRequestInfo

public interface RepositoryRequestInfo

This interface is for mapping web request paths to artifacts. The file system storage may differ from the paths used for web access.

Author:

Martin Stockhammer

Method Summary

Modifier and Type	Method and Description
<T extends RepositoryFeature<T>> RepositoryFeature<T>	getFeature(Class<T> clazz) Extension method that allows to provide different features that are not supported by all repository types.
String	getLayout(String requestPath) Returns the likely layout type for the given request.
boolean	isArchetypeCatalog(String requestPath) Returns true, if the given request points to a archetype catalog.
boolean	isMetadata(String requestPath) Tests the path to see if it conforms to the expectations of a metadata request.
boolean	isMetadataSupportFile(String requestPath) Tests the path to see if it conforms to the expectations of a support file request of the metadata file.
boolean	isSupportFile(String requestPath) Tests the path to see if it conforms to the expectations of a support file request.
<T extends RepositoryFeature<T>> boolean	supportsFeature(Class<T> clazz) Returns true, if the requested feature is supported by this repository.
ArtifactReference	toArtifactReference(String requestPath) Returns the artifact reference for a given path.
String	toNativePath(String requestPath) Adjust the requestedPath to conform to the native layout of the provided ManagedRepositoryContent.

Method Detail

toArtifactReference

ArtifactReference toArtifactReference(String requestPath)
                               throws LayoutException

Returns the artifact reference for a given path. Takes an incoming requested path (in "/" format) and gleans the layout and ArtifactReference appropriate for that content.

Parameters:

requestPath - The path of the web request

Returns:

The artifact reference

Throws:

LayoutException

isMetadata

boolean isMetadata(String requestPath)

Tests the path to see if it conforms to the expectations of a metadata request.

NOTE: The implementation may do only a cursory check on the path's extension. A result of true from this method is not a guarantee that the support resource is in a valid format, or that it even contains data.

Parameters:

requestPath - the path to test.

Returns:

true if the requestedPath is likely a metadata request.

isArchetypeCatalog

boolean isArchetypeCatalog(String requestPath)

Returns true, if the given request points to a archetype catalog.

Parameters:

requestPath -

Returns:

true if the requestedPath is likely an archetype catalog request.

isSupportFile

boolean isSupportFile(String requestPath)

Tests the path to see if it conforms to the expectations of a support file request. Support files are used for signing and validating the artifact files.

May test for certain extensions like .sha1, .md5, .asc, and .php.

NOTE: The implementation may do only a cursory check on the path's extension. A result of true from this method is not a guarantee that the support resource is in a valid format, or that it even contains data.

Parameters:

requestPath - the path to test.

Returns:

true if the requestedPath is likely that of a support file request.

isMetadataSupportFile

boolean isMetadataSupportFile(String requestPath)

Tests the path to see if it conforms to the expectations of a support file request of the metadata file.

May test for certain extensions like .sha1, .md5, .asc, and .php.

NOTE: The implementation may do only a cursory check on the path's extension. A result of true from this method is not a guarantee that the support resource is in a valid format, or that it even contains data.

Parameters:

requestPath - the path to test.

Returns:

true if the requestedPath is likely that of a support file request.

getLayout

String getLayout(String requestPath)

Returns the likely layout type for the given request. Implementations may only check the path elements for this. To make sure, the path is valid, you should call toArtifactReference(String)

Returns:

toNativePath

String toNativePath(String requestPath)
             throws LayoutException

Adjust the requestedPath to conform to the native layout of the provided ManagedRepositoryContent.

Parameters:

requestPath - the incoming requested path.

Returns:

the adjusted (to native) path.

Throws:

LayoutException - if the path cannot be parsed.

getFeature

<T extends RepositoryFeature<T>> RepositoryFeature<T> getFeature(Class<T> clazz)
                                                          throws UnsupportedFeatureException

Extension method that allows to provide different features that are not supported by all repository types.

Type Parameters:

T - This is the class of the feature

Parameters:

clazz - The feature class that is requested

Returns:

The feature implementation for this repository instance, if it is supported

Throws:

UnsupportedFeatureException - if the feature is not supported by this repository type

supportsFeature

<T extends RepositoryFeature<T>> boolean supportsFeature(Class<T> clazz)

Returns true, if the requested feature is supported by this repository.

Type Parameters:

T - The requested feature class

Parameters:

clazz - The requested feature class

Returns:

True, if the feature is supported, otherwise false.