org.apache.archiva.repository.content.maven2

Class MavenRepositoryRequestInfo

java.lang.Object

org.apache.archiva.repository.content.maven2.MavenRepositoryRequestInfo

All Implemented Interfaces:

RepositoryRequestInfo

public class MavenRepositoryRequestInfo
extends Object
implements RepositoryRequestInfo

RepositoryRequest is used to determine the type of request that is incoming, and convert it to an appropriate ArtifactReference.

Constructor Summary

Constructors

Constructor and Description
MavenRepositoryRequestInfo(ManagedRepository repository)

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 requestedPath) Returns true, if the given request points to a archetype catalog.
boolean	isMetadata(String requestedPath) Tests the path to see if it conforms to the expectations of a metadata request.
boolean	isMetadataSupportFile(String requestedPath) Tests the path to see if it conforms to the expectations of a support file request of the metadata file.
boolean	isSupportFile(String requestedPath) 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 requestedPath) Takes an incoming requested path (in "/" format) and gleans the layout and ArtifactReference appropriate for that content.
String	toNativePath(String requestedPath) Adjust the requestedPath to conform to the native layout of the provided ManagedRepositoryContent.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MavenRepositoryRequestInfo

public MavenRepositoryRequestInfo(ManagedRepository repository)

Method Detail

toArtifactReference

public ArtifactReference toArtifactReference(String requestedPath)
                                      throws LayoutException

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

Specified by:

toArtifactReference in interface RepositoryRequestInfo

Parameters:

requestedPath - the relative path to the content.

Returns:

the ArtifactReference for the requestedPath.

Throws:

LayoutException - if the request path is not layout valid.

isMetadata

public boolean isMetadata(String requestedPath)

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

NOTE: This does a cursory check on the path's last element. A result of true from this method is not a guarantee that the metadata is in a valid format, or that it even contains data.

Specified by:

isMetadata in interface RepositoryRequestInfo

Parameters:

requestedPath - the path to test.

Returns:

true if the requestedPath is likely a metadata request.

isArchetypeCatalog

public boolean isArchetypeCatalog(String requestedPath)

Description copied from interface: RepositoryRequestInfo

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

Specified by:

isArchetypeCatalog in interface RepositoryRequestInfo

Parameters:

requestedPath -

Returns:

true if the requestedPath is likely an archetype catalog request.

isSupportFile

public boolean isSupportFile(String requestedPath)

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

Tests for .sha1, .md5, .asc, and .php.

NOTE: This does a cursory check on the path's extension only. 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.

Specified by:

isSupportFile in interface RepositoryRequestInfo

Parameters:

requestedPath - the path to test.

Returns:

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

isMetadataSupportFile

public boolean isMetadataSupportFile(String requestedPath)

Description copied from interface: RepositoryRequestInfo

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.

Specified by:

isMetadataSupportFile in interface RepositoryRequestInfo

Parameters:

requestedPath - the path to test.

Returns:

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

getLayout

public String getLayout(String requestPath)

Description copied from interface: RepositoryRequestInfo

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 RepositoryRequestInfo.toArtifactReference(String)

Specified by:

getLayout in interface RepositoryRequestInfo

Returns:

toNativePath

public String toNativePath(String requestedPath)
                    throws LayoutException

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

Specified by:

toNativePath in interface RepositoryRequestInfo

Parameters:

requestedPath - the incoming requested path.

Returns:

the adjusted (to native) path.

Throws:

LayoutException - if the path cannot be parsed.

getFeature

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

Description copied from interface: RepositoryRequestInfo

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

Specified by:

getFeature in interface RepositoryRequestInfo

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

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

Description copied from interface: RepositoryRequestInfo

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

Specified by:

supportsFeature in interface RepositoryRequestInfo

Type Parameters:

T - The requested feature class

Parameters:

clazz - The requested feature class

Returns:

True, if the feature is supported, otherwise false.