RemoteCatalogArchetypeDataSource (Maven Archetype Common 2.3 API)

java.lang.Object
- org.codehaus.plexus.logging.AbstractLogEnabled
- - org.apache.maven.archetype.source.CatalogArchetypeDataSource
  - - org.apache.maven.archetype.source.RemoteCatalogArchetypeDataSource

All Implemented Interfaces:: ArchetypeDataSource, org.codehaus.plexus.logging.LogEnabled

@Component(role=ArchetypeDataSource.class,
           hint="remote-catalog")
public class RemoteCatalogArchetypeDataSource
extends CatalogArchetypeDataSource

Author:: Jason van Zyl

Field Summary

Fields
Modifier and Type Field and Description

static String REPOSITORY_ID
Id of the repository used to download catalog file.

static String REPOSITORY_PROPERTY
- Fields inherited from class org.apache.maven.archetype.source.CatalogArchetypeDataSource
  ARCHETYPE_CATALOG_FILENAME, ARCHETYPE_CATALOG_PROPERTY, DEFAULT_ARCHETYPE_CATALOG, MAVEN_CONFIGURATION, USER_HOME
- Fields inherited from interface org.apache.maven.archetype.source.ArchetypeDataSource
  ROLE

Fields
Modifier and Type	Field and Description
`static String`	`REPOSITORY_ID` Id of the repository used to download catalog file.
`static String`	`REPOSITORY_PROPERTY`

Constructor Summary

Constructors
Constructor and Description

RemoteCatalogArchetypeDataSource()

Constructors
Constructor and Description
`RemoteCatalogArchetypeDataSource()`

Method Summary

Methods
Modifier and Type	Method and Description
`ArchetypeCatalog`	`getArchetypeCatalog(Properties properties)`
`void`	`updateCatalog(Properties properties, Archetype archetype)`

Methods inherited from class org.apache.maven.archetype.source.CatalogArchetypeDataSource
readCatalog, writeLocalCatalog

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REPOSITORY_PROPERTY
```
public static final String REPOSITORY_PROPERTY
```
    See Also:
    Constant Field Values
  - REPOSITORY_ID
```
public static final String REPOSITORY_ID
```
    Id of the repository used to download catalog file. Proxy or authentication info can be setup in settings.xml.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - RemoteCatalogArchetypeDataSource
```
public RemoteCatalogArchetypeDataSource()
```
- Method Detail
  - getArchetypeCatalog
```
public ArchetypeCatalog getArchetypeCatalog(Properties properties)
                                     throws ArchetypeDataSourceException
```
    Specified by:
    
    getArchetypeCatalog in interface ArchetypeDataSource
    
    Overrides:
    
    getArchetypeCatalog in class CatalogArchetypeDataSource
    
    Throws:
    
    ArchetypeDataSourceException
  - updateCatalog
```
public void updateCatalog(Properties properties,
                 Archetype archetype)
                   throws ArchetypeDataSourceException
```
    Specified by:
    
    updateCatalog in interface ArchetypeDataSource
    
    Overrides:
    
    updateCatalog in class CatalogArchetypeDataSource
    
    Throws:
    
    ArchetypeDataSourceException

Class RemoteCatalogArchetypeDataSource

Field Summary

Fields inherited from class org.apache.maven.archetype.source.CatalogArchetypeDataSource

Fields inherited from interface org.apache.maven.archetype.source.ArchetypeDataSource

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.archetype.source.CatalogArchetypeDataSource

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

Methods inherited from class java.lang.Object

Field Detail

REPOSITORY_PROPERTY

REPOSITORY_ID

Constructor Detail

RemoteCatalogArchetypeDataSource

Method Detail

getArchetypeCatalog

updateCatalog