org.apache.archiva.rest.api.services

Interface ArchivaAdministrationService

All Known Implementing Classes:

DefaultArchivaAdministrationService

@Path(value="/archivaAdministrationService/")
public interface ArchivaAdministrationService

Since:

1.4-M1

Author:

Olivier Lamy

Method Summary

Modifier and Type	Method and Description
void	addFileType(FileType fileType)
Boolean	addFileTypePattern(String fileTypeId, String pattern)
Boolean	deleteLegacyArtifactPath(String path)
Boolean	disabledInvalidContentConsumer(String invalidContentConsumer)
Boolean	disabledKnownContentConsumer(String knownContentConsumer)
Boolean	enabledInvalidContentConsumer(String invalidContentConsumer)
void	enabledInvalidContentConsumers(List<String> invalidContentConsumers)
Boolean	enabledKnownContentConsumer(String knownContentConsumer)
void	enabledKnownContentConsumers(List<String> knownContentConsumers)
String	getApplicationUrl()
FileType	getFileType(String fileTypeId)
List<FileType>	getFileTypes()
List<AdminRepositoryConsumer>	getInvalidContentAdminRepositoryConsumers()
List<String>	getInvalidContentConsumers()
List<AdminRepositoryConsumer>	getKnownContentAdminRepositoryConsumers()
List<String>	getKnownContentConsumers()
List<LegacyArtifactPath>	getLegacyArtifactPaths()
NetworkConfiguration	getNetworkConfiguration()
OrganisationInformation	getOrganisationInformation()
UiConfiguration	getUiConfiguration()
Boolean	registrationDisabled()
Boolean	removeFileType(String fileTypeId)
Boolean	removeFileTypePattern(String fileTypeId, String pattern)
void	setNetworkConfiguration(NetworkConfiguration networkConfiguration)
void	setOrganisationInformation(OrganisationInformation organisationInformation)
void	setUiConfiguration(UiConfiguration uiConfiguration)

Method Detail

getLegacyArtifactPaths

@Path(value="getLegacyArtifactPaths")
 @GET
 @Produces(value={"application/json","application/xml"})
List<LegacyArtifactPath> getLegacyArtifactPaths()
                                                                                                                                              throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

deleteLegacyArtifactPath

@Path(value="deleteLegacyArtifactPath")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean deleteLegacyArtifactPath(@QueryParam(value="path")
                                                                                                                                                     String path)
                                                                                                                                              throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

addFileTypePattern

@Path(value="addFileTypePattern")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean addFileTypePattern(@QueryParam(value="fileTypeId")
                                                                                                                                         String fileTypeId,
                                                                                                                                         @QueryParam(value="pattern")
                                                                                                                                         String pattern)
                                                                                                                                  throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

removeFileTypePattern

@Path(value="removeFileTypePattern")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean removeFileTypePattern(@QueryParam(value="fileTypeId")
                                                                                                                                               String fileTypeId,
                                                                                                                                               @QueryParam(value="pattern")
                                                                                                                                               String pattern)
                                                                                                                                        throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getFileType

@Path(value="getFileType")
 @GET
 @Produces(value={"application/json","application/xml"})
FileType getFileType(@QueryParam(value="fileTypeId")
                                                                                                               String fileTypeId)
                                                                                                        throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

addFileType

@Path(value="addFileType")
 @POST
 @Consumes(value={"application/json","application/xml"})
void addFileType(FileType fileType)
                                                                                                     throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

removeFileType

@Path(value="removeFileType")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean removeFileType(@QueryParam(value="fileTypeId")
                                                                                                                                 String fileTypeId)
                                                                                                                          throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

enabledKnownContentConsumer

@Path(value="enabledKnownContentConsumer/{knownContentConsumer}")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean enabledKnownContentConsumer(@PathParam(value="knownContentConsumer")
                                                                                                                                                                                  String knownContentConsumer)
                                                                                                                                                                           throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

enabledKnownContentConsumers

@Path(value="enabledKnownContentConsumers")
 @POST
 @Consumes(value={"application/json","application/xml"})
void enabledKnownContentConsumers(List<String> knownContentConsumers)
                                                                                                                                       throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

disabledKnownContentConsumer

@Path(value="disabledKnownContentConsumer/{knownContentConsumer}")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean disabledKnownContentConsumer(@PathParam(value="knownContentConsumer")
                                                                                                                                                                                    String knownContentConsumer)
                                                                                                                                                                             throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

enabledInvalidContentConsumer

@Path(value="enabledInvalidContentConsumer/{invalidContentConsumer}")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean enabledInvalidContentConsumer(@PathParam(value="invalidContentConsumer")
                                                                                                                                                                                        String invalidContentConsumer)
                                                                                                                                                                                 throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

enabledInvalidContentConsumers

@Path(value="enabledInvalidContentConsumers")
 @POST
 @Consumes(value={"application/json","application/xml"})
void enabledInvalidContentConsumers(List<String> invalidContentConsumers)
                                                                                                                                           throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

disabledInvalidContentConsumer

@Path(value="disabledInvalidContentConsumer/{invalidContentConsumer}")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
Boolean disabledInvalidContentConsumer(@PathParam(value="invalidContentConsumer")
                                                                                                                                                                                          String invalidContentConsumer)
                                                                                                                                                                                   throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getFileTypes

@Path(value="getFileTypes")
 @GET
 @Produces(value={"application/json","application/xml"})
List<FileType> getFileTypes()
                                                                                                                throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getKnownContentConsumers

@Path(value="getKnownContentConsumers")
 @GET
 @Produces(value={"application/json","application/xml"})
List<String> getKnownContentConsumers()
                                                                                                                                      throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getKnownContentAdminRepositoryConsumers

@Path(value="getKnownContentAdminRepositoryConsumers")
 @GET
 @Produces(value={"application/json","application/xml"})
List<AdminRepositoryConsumer> getKnownContentAdminRepositoryConsumers()
                                                                                                                                                                                     throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

Since:

1.4-M3

getInvalidContentAdminRepositoryConsumers

@Path(value="getInvalidContentAdminRepositoryConsumers")
 @GET
 @Produces(value={"application/json","application/xml"})
List<AdminRepositoryConsumer> getInvalidContentAdminRepositoryConsumers()
                                                                                                                                                                                         throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

Since:

1.4-M3

getInvalidContentConsumers

@Path(value="getInvalidContentConsumers")
 @GET
 @Produces(value={"application/json","application/xml"})
List<String> getInvalidContentConsumers()
                                                                                                                                          throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getOrganisationInformation

@Path(value="getOrganisationInformation")
 @GET
 @Produces(value={"application/json","application/xml","text/plain"})
OrganisationInformation getOrganisationInformation()
                                                                                                                                                                  throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

setOrganisationInformation

@Path(value="setOrganisationInformation")
 @POST
 @Consumes(value={"application/json","application/xml"})
void setOrganisationInformation(OrganisationInformation organisationInformation)
                                                                                                                                   throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getUiConfiguration

@Path(value="getUiConfiguration")
 @GET
 @Produces(value={"application/json","application/xml"})
UiConfiguration getUiConfiguration()
                                                                                                                             throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

registrationDisabled

@Path(value="registrationDisabled")
 @GET
 @Produces(value={"application/json","application/xml"})
Boolean registrationDisabled()
                                                                                                                         throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

setUiConfiguration

@Path(value="setUiConfiguration")
 @POST
 @Consumes(value={"application/json","application/xml"})
void setUiConfiguration(UiConfiguration uiConfiguration)
                                                                                                                   throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

getApplicationUrl

@Path(value="applicationUrl")
 @GET
 @Produces(value="text/plain")
String getApplicationUrl()
                                                                                     throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

Since:

1.4-M3

getNetworkConfiguration

@Path(value="getNetworkConfiguration")
 @GET
 @Produces(value={"application/json","application/xml"})
NetworkConfiguration getNetworkConfiguration()
                                                                                                                                            throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException

setNetworkConfiguration

@Path(value="setNetworkConfiguration")
 @POST
 @Consumes(value={"application/json","application/xml"})
void setNetworkConfiguration(NetworkConfiguration networkConfiguration)
                                                                                                                             throws ArchivaRestServiceException

Throws:

ArchivaRestServiceException