Package org.apache.solr.api

Class AnnotatedApi

java.lang.Object

org.apache.solr.api.Api

org.apache.solr.api.AnnotatedApi

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.solr.common.SpecProvider, PermissionNameProvider

public class AnnotatedApi
extends Api
implements PermissionNameProvider, Closeable

This class implements an Api just from an annotated java class The class must have an annotation EndPoint Each method must have an annotation Command The methods that implement a command should have the first 2 parameters SolrQueryRequest and SolrQueryResponse or it may optionally have a third parameter which could be a java class annotated with jackson annotations. The third parameter is only valid if it is using a json command payload

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.security.PermissionNameProvider

PermissionNameProvider.Name

Field Summary

Fields

Modifier and Type	Field	Description
static String	ERR

Fields inherited from class org.apache.solr.api.Api

commandSchema, spec

Fields inherited from interface org.apache.solr.security.PermissionNameProvider

ANY, NULL, values

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AnnotatedApi(org.apache.solr.common.SpecProvider specProvider, EndPoint endPoint, Map<String,org.apache.solr.api.AnnotatedApi.Cmd> commands, Api fallback)

Method Summary

Modifier and Type	Method	Description
void	call(SolrQueryRequest req, SolrQueryResponse rsp)	The method that gets called for each request
void	close()
static Map<String,Object>	createSchema(Method m)
static List<Api>	getApis(Class<?> theClass, Object obj, boolean allowEmpty)	Get a list of Api-s supported by this class.
static List<Api>	getApis(Object obj)
Map<String,org.apache.solr.api.AnnotatedApi.Cmd>	getCommands()
EndPoint	getEndPoint()
PermissionNameProvider.Name	getPermissionName(AuthorizationContext request)

Methods inherited from class org.apache.solr.api.Api

getCommandSchema, getSpec

Methods inherited from class java.lang.Object

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

Field Detail

ERR

public static final String ERR

See Also:

Constant Field Values

Constructor Detail

AnnotatedApi

protected AnnotatedApi(org.apache.solr.common.SpecProvider specProvider,
                       EndPoint endPoint,
                       Map<String,org.apache.solr.api.AnnotatedApi.Cmd> commands,
                       Api fallback)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getEndPoint

public EndPoint getEndPoint()

getCommands

public Map<String,org.apache.solr.api.AnnotatedApi.Cmd> getCommands()

getApis

public static List<Api> getApis(Object obj)

getApis

public static List<Api> getApis(Class<?> theClass,
                                Object obj,
                                boolean allowEmpty)

Get a list of Api-s supported by this class.

Parameters:

theClass - class

obj - object of this class (may be null)

allowEmpty - if false then an exception is thrown if no Api-s can be retrieved, if true then absence of Api-s is silently ignored.

Returns:

list of discovered Api-s

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext request)

Specified by:

getPermissionName in interface PermissionNameProvider

call

public void call(SolrQueryRequest req,
                 SolrQueryResponse rsp)

Description copied from class: Api

The method that gets called for each request

Specified by:

call in class Api

createSchema

public static Map<String,Object> createSchema(Method m)