com.google.api.server.spi.config.model

Class ApiMethodConfig

java.lang.Object

com.google.api.server.spi.config.model.ApiMethodConfig

public class ApiMethodConfig
extends java.lang.Object

Flattened method configuration for a swarm endpoint method. Data generally originates from ApiMethod annotations.

Constructor Summary

Constructors

Constructor and Description
ApiMethodConfig(ApiMethodConfig original, ApiClassConfig apiClassConfig)
ApiMethodConfig(EndpointMethod method, TypeLoader typeLoader, ApiClassConfig apiClassConfig)

Method Summary

Modifier and Type	Method and Description
ApiParameterConfig	addParameter(java.lang.String name, java.lang.String description, boolean nullable, java.lang.String defaultValue, com.google.common.reflect.TypeToken<?> type) Adds the given parameter to the configuration and updates the path to add the new parameter if it is non-optional and has no default.
boolean	equals(java.lang.Object o)
ApiClassConfig	getApiClassConfig()
ApiConfig	getApiConfig() Shorthand for getApiClassConfig().getApiConfig().
java.util.List<java.lang.String>	getAudiences()
java.util.List<java.lang.Class<? extends Authenticator>>	getAuthenticators()
AuthLevel	getAuthLevel()
java.lang.String	getCanonicalPath()
java.util.List<java.lang.String>	getClientIds()
java.lang.String	getDescription()
java.lang.String	getEndpointMethodName()
java.lang.String	getFullJavaName() Generates, using class name and java method name, a dot-separated full name for this endpoint method.
java.lang.String	getFullMethodName() Generates, using API name and method name, a dot-separated full name for this endpoint method.
java.lang.String	getHttpMethod()
ApiIssuerAudienceConfig	getIssuerAudiences()
java.lang.String	getName()
java.util.List<ApiParameterConfig>	getParameterConfigs()
java.lang.String	getPath()
java.util.Collection<java.lang.String>	getPathParameters() Gets parameters in current path.
java.util.List<java.lang.Class<? extends PeerAuthenticator>>	getPeerAuthenticators()
java.lang.String	getRestfulSignature() Generates a string representing the signature of the method when called using REST.
com.google.common.reflect.TypeToken<?>	getReturnType()
AuthScopeExpression	getScopeExpression()
int	hashCode()
boolean	hasResourceInResponse() Returns whether or not the method has a resource (is non-void) in the response.
boolean	isApiKeyRequired()
boolean	isIgnored()
static java.lang.String	methodNameFormatter(java.lang.String methodName)
void	setApiKeyRequired(boolean apiKeyRequired)
void	setAudiences(java.util.List<java.lang.String> audiences)
void	setAuthenticators(java.util.List<java.lang.Class<? extends Authenticator>> authenticators)
void	setAuthLevel(AuthLevel authLevel)
void	setClientIds(java.util.List<java.lang.String> clientIds)
protected void	setDefaults(EndpointMethod endpointMethod, TypeLoader typeLoader, java.lang.String apiDefaultResource) Sets all fields to their default value to be used if not set otherwise.
void	setDescription(java.lang.String description)
void	setHttpMethod(java.lang.String httpMethod)
void	setIgnored(boolean ignored)
void	setIssuerAudiences(ApiIssuerAudienceConfig issuerAudiences)
void	setName(java.lang.String name)
void	setPath(java.lang.String path)
void	setPeerAuthenticators(java.util.List<java.lang.Class<? extends PeerAuthenticator>> peerAuthenticators)
void	setScopeExpression(AuthScopeExpression scopeExpression)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiMethodConfig

public ApiMethodConfig(EndpointMethod method,
                       TypeLoader typeLoader,
                       ApiClassConfig apiClassConfig)

ApiMethodConfig

public ApiMethodConfig(ApiMethodConfig original,
                       ApiClassConfig apiClassConfig)

Method Detail

setDefaults

protected void setDefaults(EndpointMethod endpointMethod,
                           TypeLoader typeLoader,
                           java.lang.String apiDefaultResource)

Sets all fields to their default value to be used if not set otherwise. Override to change the default configuration.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getApiClassConfig

public ApiClassConfig getApiClassConfig()

getApiConfig

public ApiConfig getApiConfig()

Shorthand for getApiClassConfig().getApiConfig().

getEndpointMethodName

public java.lang.String getEndpointMethodName()

getFullJavaName

public java.lang.String getFullJavaName()

Generates, using class name and java method name, a dot-separated full name for this endpoint method. This is different from the method name from getFullMethodName, which is used to uniquely identify the method within the context of the API. The java method name, however, is used to identify and reflectively call the actual java method.

addParameter

public ApiParameterConfig addParameter(java.lang.String name,
                                       java.lang.String description,
                                       boolean nullable,
                                       java.lang.String defaultValue,
                                       com.google.common.reflect.TypeToken<?> type)

Adds the given parameter to the configuration and updates the path to add the new parameter if it is non-optional and has no default.

getParameterConfigs

public java.util.List<ApiParameterConfig> getParameterConfigs()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

methodNameFormatter

public static java.lang.String methodNameFormatter(java.lang.String methodName)

getFullMethodName

public java.lang.String getFullMethodName()

Generates, using API name and method name, a dot-separated full name for this endpoint method. The name is sanitized by methodNameFormatter.

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

setPath

public void setPath(java.lang.String path)

getPath

public java.lang.String getPath()

getCanonicalPath

public java.lang.String getCanonicalPath()

setHttpMethod

public void setHttpMethod(java.lang.String httpMethod)

getHttpMethod

public java.lang.String getHttpMethod()

getRestfulSignature

public java.lang.String getRestfulSignature()

Generates a string representing the signature of the method when called using REST. Can be used to determine ambiguity of such REST calls. For example, a method with path "getFoo/{idA}/bar/{idB}" using http method GET would generate the rest path "GET getFoo/{}/bar/{}".

setAuthLevel

public void setAuthLevel(AuthLevel authLevel)

getAuthLevel

public AuthLevel getAuthLevel()

setScopeExpression

public void setScopeExpression(AuthScopeExpression scopeExpression)

getScopeExpression

public AuthScopeExpression getScopeExpression()

setAudiences

public void setAudiences(java.util.List<java.lang.String> audiences)

getAudiences

public java.util.List<java.lang.String> getAudiences()

setIssuerAudiences

public void setIssuerAudiences(ApiIssuerAudienceConfig issuerAudiences)

getIssuerAudiences

public ApiIssuerAudienceConfig getIssuerAudiences()

setClientIds

public void setClientIds(java.util.List<java.lang.String> clientIds)

getClientIds

public java.util.List<java.lang.String> getClientIds()

setAuthenticators

public void setAuthenticators(java.util.List<java.lang.Class<? extends Authenticator>> authenticators)

getAuthenticators

public java.util.List<java.lang.Class<? extends Authenticator>> getAuthenticators()

setPeerAuthenticators

public void setPeerAuthenticators(java.util.List<java.lang.Class<? extends PeerAuthenticator>> peerAuthenticators)

getPeerAuthenticators

public java.util.List<java.lang.Class<? extends PeerAuthenticator>> getPeerAuthenticators()

setIgnored

public void setIgnored(boolean ignored)

isIgnored

public boolean isIgnored()

setApiKeyRequired

public void setApiKeyRequired(boolean apiKeyRequired)

isApiKeyRequired

public boolean isApiKeyRequired()

getPathParameters

public java.util.Collection<java.lang.String> getPathParameters()

Gets parameters in current path.

getReturnType

public com.google.common.reflect.TypeToken<?> getReturnType()

hasResourceInResponse

public boolean hasResourceInResponse()

Returns whether or not the method has a resource (is non-void) in the response.