org.apache.drill.exec.server.rest

Class StorageResources

java.lang.Object

org.apache.drill.exec.server.rest.StorageResources

@Path(value="/")
 @RolesAllowed(value="admin")
public class StorageResources
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	StorageResources.JsonResult
static class	StorageResources.StoragePluginModel Model class for Storage Plugin page.

Constructor Summary

Constructors

Constructor and Description
StorageResources()

Method Summary

Modifier and Type	Method and Description
StorageResources.JsonResult	createOrUpdatePlugin(PluginConfigWrapper plugin) Deprecated. use createOrUpdatePluginJSON(org.apache.drill.exec.server.rest.PluginConfigWrapper) instead
StorageResources.JsonResult	createOrUpdatePlugin(String name, String storagePluginConfig)
StorageResources.JsonResult	createOrUpdatePluginJSON(PluginConfigWrapper plugin)
StorageResources.JsonResult	deletePlugin(String name)
StorageResources.JsonResult	deletePluginViaGet(String name) Deprecated. use the method with DELETE request deletePlugin(String) instead
StorageResources.JsonResult	enablePlugin(String name, Boolean enable)
StorageResources.JsonResult	enablePluginViaGet(String name, Boolean enable) Deprecated. use the method with POST request enablePlugin(java.lang.String, java.lang.Boolean) instead
javax.ws.rs.core.Response	exportPlugin(String name, String format) Regex allows the following paths: /storage/{name}/export "/storage/{name}/export/{format} Note: for the second case the format involves the leading slash, therefore it should be removed then
List<PluginConfigWrapper>	getConfigsFor(String pluginGroup) Regex allows the following paths:
javax.ws.rs.core.Response	getConfigsFor(String pluginGroup, String format) Regex allows the following paths:
org.glassfish.jersey.server.mvc.Viewable	getPlugin(String name)
PluginConfigWrapper	getPluginConfig(String name)
org.glassfish.jersey.server.mvc.Viewable	getPlugins()
List<PluginConfigWrapper>	getPluginsJSON()

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageResources

public StorageResources()

Method Detail

getConfigsFor

@GET
 @Path(value="/storage/{group}/plugins/export{format: (/[^/]+?)*}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getConfigsFor(@PathParam(value="group")
                                                                                                                                                             String pluginGroup,
                                                                                                                                                             @PathParam(value="format")
                                                                                                                                                             String format)

Regex allows the following paths:

 /storage/{group}/plugins/export
 /storage/{group}/plugins/export/{format}

Note: for the second case the format involves the leading slash, therefore it should be removed then

getPluginsJSON

@GET
 @Path(value="/storage.json")
 @Produces(value="application/json")
public List<PluginConfigWrapper> getPluginsJSON()

getPlugins

@GET
 @Path(value="/storage")
 @Produces(value="text/html")
public org.glassfish.jersey.server.mvc.Viewable getPlugins()

getPluginConfig

@GET
 @Path(value="/storage/{name}.json")
 @Produces(value="application/json")
public PluginConfigWrapper getPluginConfig(@PathParam(value="name")
                                                                                                                          String name)

getPlugin

@GET
 @Path(value="/storage/{name}")
 @Produces(value="text/html")
public org.glassfish.jersey.server.mvc.Viewable getPlugin(@PathParam(value="name")
                                                                                                                             String name)

enablePlugin

@POST
 @Path(value="/storage/{name}/enable/{val}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public StorageResources.JsonResult enablePlugin(@PathParam(value="name")
                                                                                                                                                                             String name,
                                                                                                                                                                             @PathParam(value="val")
                                                                                                                                                                             Boolean enable)

enablePluginViaGet

@GET
 @Path(value="/storage/{name}/enable/{val}")
 @Produces(value="application/json")
 @Deprecated
public StorageResources.JsonResult enablePluginViaGet(@PathParam(value="name")
                                                                                                                                                          String name,
                                                                                                                                                          @PathParam(value="val")
                                                                                                                                                          Boolean enable)

Deprecated. use the method with POST request enablePlugin(java.lang.String, java.lang.Boolean) instead

exportPlugin

@GET
 @Path(value="/storage/{name}/export{format: (/[^/]+?)*}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response exportPlugin(@PathParam(value="name")
                                                                                                                                                   String name,
                                                                                                                                                   @PathParam(value="format")
                                                                                                                                                   String format)

Regex allows the following paths: /storage/{name}/export "/storage/{name}/export/{format} Note: for the second case the format involves the leading slash, therefore it should be removed then

deletePlugin

@DELETE
 @Path(value="/storage/{name}.json")
 @Produces(value="application/json")
public StorageResources.JsonResult deletePlugin(@PathParam(value="name")
                                                                                                                                  String name)

createOrUpdatePluginJSON

@POST
 @Path(value="/storage/{name}.json")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public StorageResources.JsonResult createOrUpdatePluginJSON(PluginConfigWrapper plugin)

createOrUpdatePlugin

@POST
 @Path(value="/storage/create_update")
 @Consumes(value="application/x-www-form-urlencoded")
 @Produces(value="application/json")
public StorageResources.JsonResult createOrUpdatePlugin(@FormParam(value="name")
                                                                                                                                                                                                String name,
                                                                                                                                                                                                @FormParam(value="config")
                                                                                                                                                                                                String storagePluginConfig)

getConfigsFor

@GET
 @Path(value="/storage{group: (/[^/]+?)*}-plugins.json")
 @Produces(value="application/json")
public List<PluginConfigWrapper> getConfigsFor(@PathParam(value="group")
                                                                                                                                                  String pluginGroup)

Regex allows the following paths:

 /storage.json
 /storage/{group}-plugins.json

Allowable groups:

• "all" ALL_PLUGINS
• "enabled" ENABLED_PLUGINS
• "disabled" DISABLED_PLUGINS

Any other group value results in an empty list.

Note: for the second case the group involves the leading slash, therefore it should be removed then

createOrUpdatePlugin

@POST
 @Path(value="/storage/{name}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Deprecated
public StorageResources.JsonResult createOrUpdatePlugin(PluginConfigWrapper plugin)

Deprecated. use createOrUpdatePluginJSON(org.apache.drill.exec.server.rest.PluginConfigWrapper) instead

deletePluginViaGet

@GET
 @Path(value="/storage/{name}/delete")
 @Produces(value="application/json")
 @Deprecated
public StorageResources.JsonResult deletePluginViaGet(@PathParam(value="name")
                                                                                                                                                    String name)

Deprecated. use the method with DELETE request deletePlugin(String) instead