List<String> getKnownContentConsumers()
throws ArchivaRestServiceException;
+ /**
+ * @since 1.4-M3
+ */
@Path( "getKnownContentAdminRepositoryConsumers" )
@GET
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
@RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
- /**
- * @since 1.4-M3
- */
List<AdminRepositoryConsumer> getKnownContentAdminRepositoryConsumers()
throws ArchivaRestServiceException;
+ /**
+ * @since 1.4-M3
+ */
@Path( "getInvalidContentAdminRepositoryConsumers" )
@GET
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
@RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
- /**
- * @since 1.4-M3
- */
List<AdminRepositoryConsumer> getInvalidContentAdminRepositoryConsumers()
throws ArchivaRestServiceException;
void setUiConfiguration( UiConfiguration uiConfiguration )
throws ArchivaRestServiceException;
+ /**
+ * @since 1.4-M3
+ */
@Path( "applicationUrl" )
@GET
@Produces( MediaType.TEXT_PLAIN )
@RedbackAuthorization( noRestriction = true, noPermission = true )
- /**
- * @since 1.4-M3
- */
String getApplicationUrl()
throws ArchivaRestServiceException;
BrowseResult getRootGroups( @QueryParam ("repositoryId") String repositoryId )
throws ArchivaRestServiceException;
- @Path ("browseGroupId/{groupId}")
- @GET
- @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization (noPermission = true, noRestriction = true)
/**
* @param groupId groupId to browse
* @param repositoryId optionnal (repository to browse if <code>null</code> all available user repositories are used)
*/
+ @Path ("browseGroupId/{groupId}")
+ @GET
+ @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
+ @RedbackAuthorization (noPermission = true, noRestriction = true)
BrowseResult browseGroupId( @PathParam ("groupId") String groupId,
@QueryParam ("repositoryId") String repositoryId )
throws ArchivaRestServiceException;
@QueryParam ("repositoryId") String repositoryId )
throws ArchivaRestServiceException;
+ /**
+ * @return List of managed repositories current user can read
+ */
@Path ("userRepositories")
@GET
@Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@RedbackAuthorization (noPermission = true, noRestriction = true)
- /**
- * @return List of managed repositories current user can read
- */
List<ManagedRepository> getUserRepositories()
throws ArchivaRestServiceException;
- @Path ("treeEntries/{g}/{a}/{v}")
- @GET
- @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization (noPermission = true, noRestriction = true)
/**
* return the dependency Tree for an artifacts
* <b>the List result has only one entry</b>
*/
+ @Path ("treeEntries/{g}/{a}/{v}")
+ @GET
+ @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
+ @RedbackAuthorization (noPermission = true, noRestriction = true)
List<TreeEntry> getTreeEntries( @PathParam ("g") String groupId, @PathParam ("a") String artifactId,
@PathParam ("v") String version, @QueryParam ("repositoryId") String repositoryId )
throws ArchivaRestServiceException;
+ /**
+ * List of artifacts using the artifact passed in parameter.
+ */
@Path ("dependees/{g}/{a}/{v}")
@GET
@Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@RedbackAuthorization (noPermission = true, noRestriction = true)
- /**
- * List of artifacts using the artifact passed in parameter.
- */
List<Artifact> getDependees( @PathParam ("g") String groupId, @PathParam ("a") String artifactId,
@PathParam ("v") String version, @QueryParam ("repositoryId") String repositoryId )
throws ArchivaRestServiceException;
@QueryParam ("repositoryId") String repositoryId )
throws ArchivaRestServiceException;
+ /**
+ * if path is empty content of the file is returned (for pom view)
+ */
@Path ("artifactContentText/{g}/{a}/{v}")
@GET
@Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@RedbackAuthorization (noPermission = true, noRestriction = true)
- /**
- * if path is empty content of the file is returned (for pom view)
- */
ArtifactContent getArtifactContentText( @PathParam ("g") String groupId, @PathParam ("a") String artifactId,
@PathParam ("v") String version, @QueryParam ("c") String classifier,
@QueryParam ("t") String type, @QueryParam ("p") String path,
@QueryParam ("repositoryId") String repositoryId )
throws ArchivaRestServiceException;
- @Path ("artifactAvailable/{g}/{a}/{v}")
- @GET
- @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization (noPermission = true, noRestriction = true)
/**
* verify if an artifact is available locally if not download from proxies will be try
* @since 1.4-M3
*/
+ @Path ("artifactAvailable/{g}/{a}/{v}")
+ @GET
+ @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
+ @RedbackAuthorization (noPermission = true, noRestriction = true)
Boolean artifactAvailable( @PathParam ("g") String groupId, @PathParam ("a") String artifactId,
@PathParam ("v") String version, @QueryParam ("repositoryId") String repositoryId )
throws ArchivaRestServiceException;
- @Path ("artifacts/{r}")
- @GET
- @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization (noPermission = true, noRestriction = true)
/**
*
* return List of all artifacts from this repository
* @throws ArchivaRestServiceException
* @since 1.4-M3
*/
+ @Path ("artifacts/{r}")
+ @GET
+ @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
+ @RedbackAuthorization (noPermission = true, noRestriction = true)
List<Artifact> getArtifacts( @PathParam ( "r" ) String repositoryId )
throws ArchivaRestServiceException;
}
@Path( "/commonServices/" )
public interface CommonServices
{
- @Path( "getI18nResources" )
- @GET
- @Produces( { MediaType.TEXT_PLAIN } )
- @RedbackAuthorization( noRestriction = true )
+
/**
* will return properties available in org/apache/archiva/i18n/default.properties
* load default (en) then override with locale used so at least en are returned if no
* translation in the locale asked.
*/
- String getI18nResources( @QueryParam( "locale" ) String locale )
- throws ArchivaRestServiceException;
-
- @Path( "getAllI18nResources" )
+ @Path( "getI18nResources" )
@GET
@Produces( { MediaType.TEXT_PLAIN } )
@RedbackAuthorization( noRestriction = true )
+ String getI18nResources( @QueryParam( "locale" ) String locale )
+ throws ArchivaRestServiceException;
+
/**
* will return properties available in org/apache/archiva/i18n/default.properties
* load default (en) then override with locale used so at least en are returned if no
* translation in the locale asked.
* This method will add redback resources too. note Archva wins
*/
+ @Path( "getAllI18nResources" )
+ @GET
+ @Produces( { MediaType.TEXT_PLAIN } )
+ @RedbackAuthorization( noRestriction = true )
String getAllI18nResources( @QueryParam( "locale" ) String locale )
throws ArchivaRestServiceException;
Boolean updateManagedRepository( ManagedRepository managedRepository )
throws ArchivaRestServiceException;
+ /**
+ * @since 1.4-M3
+ */
@Path( "fileLocationExists" )
@GET
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
@RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
- /**
- * @since 1.4-M3
- */
Boolean fileLocationExists( @QueryParam( "fileLocation" ) String fileLocation )
throws ArchivaRestServiceException;
+ /**
+ * @since 1.4-M3
+ */
@Path( "getManagedRepositoryStatistics/{repositoryId}/{lang}" )
@GET
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
@RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
- /**
- * @since 1.4-M3
- */
ArchivaRepositoryStatistics getManagedRepositoryStatistics( @PathParam( "repositoryId" ) String repositoryId,
@PathParam( "lang" ) String lang )
throws ArchivaRestServiceException;
- @Path( "getPomSnippet/{repositoryId}" )
- @GET
- @Produces( { MediaType.TEXT_PLAIN } )
- @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
/**
* return a pom snippet to use this repository with entities escaped (< > )
* @since 1.4-M3
*/
+ @Path( "getPomSnippet/{repositoryId}" )
+ @GET
+ @Produces( { MediaType.TEXT_PLAIN } )
+ @RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
String getPomSnippet( @PathParam( "repositoryId" ) String repositoryId )
throws ArchivaRestServiceException;
@Path ("/mergeRepositoriesService/")
public interface MergeRepositoriesService
{
- @Path ("mergeConflictedArtifacts/{sourceRepositoryId}/{targetRepositoryId}")
- @GET
- @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_MERGE_REPOSITORY)
+
/**
* <b>permissions are checked in impl</b>
* @since 1.4-M3
*/
+ @Path ("mergeConflictedArtifacts/{sourceRepositoryId}/{targetRepositoryId}")
+ @GET
+ @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
+ @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_MERGE_REPOSITORY)
List<Artifact> getMergeConflictedArtifacts( @PathParam ("sourceRepositoryId") String sourceRepositoryId,
@PathParam ("targetRepositoryId") String targetRepositoryId )
throws ArchivaRestServiceException;
- @Path ("mergeRepositories/{sourceRepositoryId}/{targetRepositoryId}/{skipConflicts}")
- @GET
- @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_MERGE_REPOSITORY)
/**
* <b>permissions are checked in impl</b>
* @since 1.4-M3
*/
+ @Path ("mergeRepositories/{sourceRepositoryId}/{targetRepositoryId}/{skipConflicts}")
+ @GET
+ @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_MERGE_REPOSITORY)
void mergeRepositories( @PathParam ("sourceRepositoryId") String sourceRepositoryId,
@PathParam ("targetRepositoryId") String targetRepositoryId,
@PathParam ("skipConflicts") boolean skipConflicts )
Boolean deleteProxyConnector( ProxyConnector proxyConnector )
throws ArchivaRestServiceException;
+ /**
+ * @since 1.4-M3
+ */
@Path( "removeProxyConnector" )
@GET
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
@RedbackAuthorization( permissions = ArchivaRoleConstants.OPERATION_MANAGE_CONFIGURATION )
- /**
- * @since 1.4-M3
- */
Boolean removeProxyConnector( @QueryParam( "sourceRepoId" ) String sourceRepoId,
@QueryParam( "targetRepoId" ) String targetRepoId )
throws ArchivaRestServiceException;
public interface RepositoriesService
{
+ /**
+ * index repository
+ */
@Path ("scanRepository")
@GET
@Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
@RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER)
- /**
- * index repository
- */
Boolean scanRepository( @QueryParam ("repositoryId") String repositoryId,
@QueryParam ("fullScan") boolean fullScan )
throws ArchivaRestServiceException;
- @Path ("scanRepositoryDirectoriesNow/{repositoryId}")
- @GET
- @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
- @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER)
/**
* scan directories
* @since 1.4-M3
*/
+ @Path ("scanRepositoryDirectoriesNow/{repositoryId}")
+ @GET
+ @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
+ @RedbackAuthorization (permissions = ArchivaRoleConstants.OPERATION_RUN_INDEXER)
RepositoryScanStatistics scanRepositoryDirectoriesNow( @PathParam ("repositoryId") String repositoryId )
throws ArchivaRestServiceException;
@QueryParam ("fullScan") boolean fullScan )
throws ArchivaRestServiceException;
+ /**
+ * permissions are checked in impl
+ * will copy an artifact from the source repository to the target repository
+ */
@Path ("copyArtifact")
@POST
@Consumes ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
@RedbackAuthorization (noPermission = true)
- /**
- * permissions are checked in impl
- * will copy an artifact from the source repository to the target repository
- */
Boolean copyArtifact( ArtifactTransferRequest artifactTransferRequest )
throws ArchivaRestServiceException;
throws ArchivaRestServiceException;
+ /**
+ * <b>permissions are checked in impl</b>
+ * @since 1.4-M2
+ */
@Path ("deleteArtifact")
@POST
@Consumes ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
@RedbackAuthorization (noPermission = true)
- /**
- * <b>permissions are checked in impl</b>
- * @since 1.4-M2
- */
Boolean deleteArtifact( Artifact artifact )
throws ArchivaRestServiceException;
- @Path ("projectVersion/{repositoryId}/{namespace}/{projectId}/{version}")
- @DELETE
- @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
- @RedbackAuthorization (noPermission = true)
/**
* <b>permissions are checked in impl</b>
* @since 1.4-M4
*/
+ @Path ("projectVersion/{repositoryId}/{namespace}/{projectId}/{version}")
+ @DELETE
+ @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
+ @RedbackAuthorization (noPermission = true)
Boolean removeProjectVersion( @PathParam ( "repositoryId" ) String repositoryId,
@PathParam ( "namespace" ) String namespace, @PathParam ( "projectId" ) String projectId,
@PathParam ( "version" ) String version )
Boolean isAuthorizedToDeleteArtifacts( @PathParam ("repositoryId") String repoId )
throws ArchivaRestServiceException;
- @Path ("deleteGroupId")
- @GET
- @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
- @RedbackAuthorization (noPermission = true)
/**
* <b>permissions are checked in impl</b>
* @since 1.4-M3
*/
+ @Path ("deleteGroupId")
+ @GET
+ @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
+ @RedbackAuthorization (noPermission = true)
Boolean deleteGroupId( @QueryParam ("groupId") String groupId, @QueryParam ("repositoryId") String repositoryId )
throws ArchivaRestServiceException;
- @Path ("project/{repositoryId}/{groupId}/{projectId}")
- @DELETE
- @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
- @RedbackAuthorization (noPermission = true)
/**
* <b>permissions are checked in impl</b>
* @since 1.4-M4
*/
+ @Path ("project/{repositoryId}/{groupId}/{projectId}")
+ @DELETE
+ @Produces ({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN })
+ @RedbackAuthorization (noPermission = true)
Boolean deleteProject( @PathParam ("groupId") String groupId, @PathParam ("projectId") String projectId,
@PathParam ("repositoryId") String repositoryId )
throws ArchivaRestServiceException;
List<Artifact> quickSearch( @QueryParam( "queryString" ) String queryString )
throws ArchivaRestServiceException;
- @Path( "quickSearchWithRepositories" )
- @POST
- @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
- @RedbackAuthorization( noPermission = true, noRestriction = true )
/**
* <b>if not repositories in SearchRequest: search will be apply on all repositories the current user has karma</b>
*/
- List<Artifact> quickSearchWithRepositories( SearchRequest searchRequest )
- throws ArchivaRestServiceException;
-
- @Path( "searchArtifacts" )
+ @Path( "quickSearchWithRepositories" )
@POST
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
@RedbackAuthorization( noPermission = true, noRestriction = true )
+
+ List<Artifact> quickSearchWithRepositories( SearchRequest searchRequest )
+ throws ArchivaRestServiceException;
+
/**
* If searchRequest contains repositories, the search will be done only on those repositories.
* <b>if no repositories, the search will be apply on all repositories the current user has karma</b>
*/
+ @Path( "searchArtifacts" )
+ @POST
+ @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
+ @RedbackAuthorization( noPermission = true, noRestriction = true )
List<Artifact> searchArtifacts( SearchRequest searchRequest )
throws ArchivaRestServiceException;
+ /**
+ * <b>search will be apply on all repositories the current user has karma</b>
+ */
@Path( "getArtifactVersions" )
@GET
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
@RedbackAuthorization( noPermission = true, noRestriction = true )
- /**
- * <b>search will be apply on all repositories the current user has karma</b>
- */
List<Artifact> getArtifactVersions( @QueryParam( "groupId" ) String groupId,
@QueryParam( "artifactId" ) String artifactId,
@QueryParam( "packaging" ) String packaging )
throws ArchivaRestServiceException;
+ /**
+ * <b>this method applies on Maven Indexer lucene index, so datas not yet indexed won't be available</b>
+ */
@Path( "getAllGroupIds" )
@GET
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
@RedbackAuthorization( noPermission = true, noRestriction = false )
- /**
- * <b>this method applies on Maven Indexer lucene index, so datas not yet indexed won't be available</b>
- */
GroupIdList getAllGroupIds( @QueryParam( "selectedRepos" ) List<String> selectedRepos )
throws ArchivaRestServiceException;
+ /**
+ * @since 1.4-M3
+ */
@Path( "observableRepoIds" )
@GET
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
@RedbackAuthorization( noPermission = true, noRestriction = true )
- /**
- * @since 1.4-M3
- */
StringList getObservablesRepoIds()
throws ArchivaRestServiceException;