com.google.api.server.spi

Class SystemService

java.lang.Object

com.google.api.server.spi.SystemService

public class SystemService
extends java.lang.Object

System service that execute service methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SystemService.Builder A SystemService builder which encapsulates common logic for building its dependencies.
static class	SystemService.EndpointNode

Field Summary

Fields

Modifier and Type	Field and Description
static int	DUPLICATE_SERVICE_REGISTER_COUNT
static java.lang.String	MIME_JSON

Constructor Summary

Constructors

Constructor and Description
SystemService(ApiConfigLoader configLoader, java.lang.String appName, ApiConfigWriter configWriter, boolean isIllegalArgumentBackendError) Constructs a SystemService with no registered services.
SystemService(ApiConfigLoader configLoader, java.lang.String appName, ApiConfigWriter configWriter, java.lang.Object[] services, boolean isIllegalArgumentBackendError) Constructs a SystemService and registers the provided services.

Method Summary

Modifier and Type	Method and Description
static SystemService.Builder	builder()
java.lang.Object	findService(java.lang.String name) Finds a service object with the name
java.lang.reflect.Method	findServiceMethod(java.lang.Object service, java.lang.String methodName) Finds a method object with the given methodName on the service object.
java.util.Map<ApiKey,java.lang.String>	getApiConfigs() Generates wire-format configuration for all loaded APIs.
com.google.common.collect.ImmutableList<SystemService.EndpointNode>	getEndpoints()
ApiSerializationConfig	getSerializationConfig(java.lang.String serviceName) Gets the serialization configuration for the API corresponding to the named service.
void	invokeServiceMethod(java.lang.Object service, java.lang.reflect.Method method, ParamReader paramReader, ResultWriter resultWriter) Invokes a method on a service given a paramReader to read parameters and a resultWriter to write result.
int	registerService(java.lang.Class<?> serviceClass, java.lang.Object service) Registers a service class.
int	registerService(java.lang.Object service)
EndpointMethod	resolveService(java.lang.String serviceName, java.lang.String methodName) Finds a service object with the serviceName or null if not found.
<T> SystemService.EndpointNode	updateEndpointConfig(T endpoint, ApiConfig newConfig, SystemService.EndpointNode oldNode)

Methods inherited from class java.lang.Object

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

Field Detail

MIME_JSON

public static final java.lang.String MIME_JSON

See Also:

Constant Field Values

DUPLICATE_SERVICE_REGISTER_COUNT

public static final int DUPLICATE_SERVICE_REGISTER_COUNT

See Also:

Constant Field Values

Constructor Detail

SystemService

public SystemService(ApiConfigLoader configLoader,
                     java.lang.String appName,
                     ApiConfigWriter configWriter,
                     java.lang.Object[] services,
                     boolean isIllegalArgumentBackendError)
              throws ApiConfigException

Constructs a SystemService and registers the provided services.

Parameters:

configLoader - The loader used to read annotation from service classes

appName - The application's id

services - The service classes to be registered

Throws:

ApiConfigException

SystemService

public SystemService(ApiConfigLoader configLoader,
                     java.lang.String appName,
                     ApiConfigWriter configWriter,
                     boolean isIllegalArgumentBackendError)
              throws ApiConfigException

Constructs a SystemService with no registered services.

Parameters:

configLoader - The loader used to read annotation from service classes

appName - The application's id

Throws:

ApiConfigException

Method Detail

registerService

public int registerService(java.lang.Class<?> serviceClass,
                           java.lang.Object service)
                    throws ApiConfigException

Registers a service class. Only public methods in this class and all its superclasses, except Object, are registered. Two methods are not allowed to have the same name. Registering a different service with an existing name is a no-op.

Parameters:

serviceClass - is the class to start parsing endpoints

service - Service object

Returns:

number of service methods added, -1 on duplicate insertion

Throws:

ApiConfigException

registerService

public int registerService(java.lang.Object service)
                    throws ApiConfigException

Throws:

ApiConfigException

updateEndpointConfig

public <T> SystemService.EndpointNode updateEndpointConfig(T endpoint,
                                                           ApiConfig newConfig,
                                                           @Nullable
                                                           SystemService.EndpointNode oldNode)

resolveService

public EndpointMethod resolveService(java.lang.String serviceName,
                                     java.lang.String methodName)
                              throws ServiceException

Finds a service object with the serviceName or null if not found.

Parameters:

serviceName - either a full class name or a simple name of a service object

methodName - the method name of a service object

Throws:

ServiceException - when more than one service is mapped to the same name or when the named service does not exist

getSerializationConfig

public ApiSerializationConfig getSerializationConfig(java.lang.String serviceName)

Gets the serialization configuration for the API corresponding to the named service.

findService

public java.lang.Object findService(java.lang.String name)
                             throws ServiceException

Finds a service object with the name

Throws:

ServiceException - when more than one service is mapped to the same name or when the named service does not exist

findServiceMethod

public java.lang.reflect.Method findServiceMethod(java.lang.Object service,
                                                  java.lang.String methodName)
                                           throws ServiceException

Finds a method object with the given methodName on the service object.

Throws:

ServiceException - if method does not exist

invokeServiceMethod

public void invokeServiceMethod(java.lang.Object service,
                                java.lang.reflect.Method method,
                                ParamReader paramReader,
                                ResultWriter resultWriter)
                         throws java.io.IOException

Invokes a method on a service given a paramReader to read parameters and a resultWriter to write result.

Throws:

java.io.IOException

getApiConfigs

public java.util.Map<ApiKey,java.lang.String> getApiConfigs()
                                                     throws ApiConfigException

Generates wire-format configuration for all loaded APIs.

Returns:

A map from ApiKeys to wire-formatted configuration strings.

Throws:

ApiConfigException

getEndpoints

public com.google.common.collect.ImmutableList<SystemService.EndpointNode> getEndpoints()

builder

public static SystemService.Builder builder()