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

Class ApiConfig

java.lang.Object

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

public class ApiConfig
extends java.lang.Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiConfig.Factory Simple factory to create ApiConfig instances.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApiConfig(ApiConfig original) Hidden copy constructor.
protected	ApiConfig(ServiceContext serviceContext, TypeLoader typeLoader, java.lang.Class<?> apiClass) Hidden constructor.

Method Summary

Modifier and Type	Method and Description
protected ApiClassConfig	createApiClassConfig(TypeLoader typeLoader, java.lang.Class<?> apiClass)
protected ApiAuthConfig	createAuthConfig() Creates the auth configuration object.
protected ApiCacheControlConfig	createCacheControlConfig() Creates the cache control configuration object.
protected ApiFrontendLimitsConfig	createFrontendLimitsConfig() Creates the frontend limits configuration object.
protected ApiNamespaceConfig	createNamespaceConfig() Creates the namespace configuration object.
protected ApiSerializationConfig	createSerializationConfig() Creates the serialization configuration object.
void	ensureGoogleIssuer()
boolean	equals(java.lang.Object o)
ApiClassConfig	getApiClassConfig()
ApiKey	getApiKey()
java.util.List<java.lang.String>	getAudiences()
ApiAuthConfig	getAuthConfig()
java.util.List<java.lang.Class<? extends Authenticator>>	getAuthenticators()
AuthLevel	getAuthLevel()
java.lang.String	getBackendRoot()
ApiCacheControlConfig	getCacheControlConfig()
java.lang.String	getCanonicalName()
java.util.List<java.lang.String>	getClientIds()
java.lang.Iterable<ApiConfigInconsistency<java.lang.Object>>	getConfigurationInconsistencies(ApiConfig config)
java.lang.String	getDescription()
java.lang.String	getDocumentationLink()
ApiFrontendLimitsConfig	getFrontendLimitsConfig()
boolean	getIsAbstract()
boolean	getIsDefaultVersion()
boolean	getIsDiscoverable()
ApiIssuerAudienceConfig	getIssuerAudiences()
ApiIssuerConfigs	getIssuers()
java.lang.String	getName()
ApiNamespaceConfig	getNamespaceConfig()
java.util.List<java.lang.Class<? extends PeerAuthenticator>>	getPeerAuthenticators()
java.lang.String	getResource()
java.lang.String	getRoot()
AuthScopeExpression	getScopeExpression()
ApiSerializationConfig	getSerializationConfig()
java.lang.String	getTitle()
boolean	getUseDatastore()
java.lang.String	getVersion()
int	hashCode()
boolean	isApiKeyRequired()
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	setBackendRoot(java.lang.String backendRoot)
void	setCanonicalName(java.lang.String canonicalName)
void	setClientIds(java.util.List<java.lang.String> clientIds)
protected void	setDefaults(ServiceContext serviceContext) Sets all fields to their default value to be used if not set otherwise.
void	setDescription(java.lang.String description)
void	setDocumentationLink(java.lang.String documentationLink)
void	setIsAbstract(boolean isAbstract)
void	setIsDefaultVersion(boolean defaultVersion)
void	setIsDiscoverable(boolean discoverable)
void	setIssuerAudiences(ApiIssuerAudienceConfig issuerAudiences)
void	setIssuers(ApiIssuerConfigs issuers)
void	setName(java.lang.String name)
void	setPeerAuthenticators(java.util.List<java.lang.Class<? extends PeerAuthenticator>> peerAuthenticators)
void	setResource(java.lang.String resource)
void	setRoot(java.lang.String root)
void	setScopeExpression(AuthScopeExpression scopeExpression)
void	setTitle(java.lang.String title)
void	setUseDatastore(boolean useDatastore)
void	setVersion(java.lang.String version)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiConfig

protected ApiConfig(ServiceContext serviceContext,
                    TypeLoader typeLoader,
                    java.lang.Class<?> apiClass)

Hidden constructor. Instantiate using ApiConfig.Factory.

ApiConfig

protected ApiConfig(ApiConfig original)

Hidden copy constructor. Use ApiConfig.Factory.

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getConfigurationInconsistencies

public java.lang.Iterable<ApiConfigInconsistency<java.lang.Object>> getConfigurationInconsistencies(ApiConfig config)

Returns:

true if all API-level (not class or method specific) configuration is identical.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

createAuthConfig

protected ApiAuthConfig createAuthConfig()

Creates the auth configuration object. Override to use a subclass instead.

createCacheControlConfig

protected ApiCacheControlConfig createCacheControlConfig()

Creates the cache control configuration object. Override to use a subclass instead.

createFrontendLimitsConfig

protected ApiFrontendLimitsConfig createFrontendLimitsConfig()

Creates the frontend limits configuration object. Override to use a subclass instead.

createSerializationConfig

protected ApiSerializationConfig createSerializationConfig()

Creates the serialization configuration object. Override to use a subclass instead.

createNamespaceConfig

protected ApiNamespaceConfig createNamespaceConfig()

Creates the namespace configuration object. Override to use a subclass instead.

createApiClassConfig

protected ApiClassConfig createApiClassConfig(TypeLoader typeLoader,
                                              java.lang.Class<?> apiClass)

setDefaults

protected void setDefaults(ServiceContext serviceContext)

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

getApiKey

public ApiKey getApiKey()

setRoot

public void setRoot(java.lang.String root)

getRoot

public java.lang.String getRoot()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setCanonicalName

public void setCanonicalName(java.lang.String canonicalName)

getCanonicalName

public java.lang.String getCanonicalName()

setTitle

public void setTitle(java.lang.String title)

getTitle

public java.lang.String getTitle()

setVersion

public void setVersion(java.lang.String version)

getVersion

public java.lang.String getVersion()

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

setDocumentationLink

public void setDocumentationLink(java.lang.String documentationLink)

getDocumentationLink

public java.lang.String getDocumentationLink()

setBackendRoot

public void setBackendRoot(java.lang.String backendRoot)

getBackendRoot

public java.lang.String getBackendRoot()

setIsAbstract

public void setIsAbstract(boolean isAbstract)

getIsAbstract

public boolean getIsAbstract()

setIsDefaultVersion

public void setIsDefaultVersion(boolean defaultVersion)

getIsDefaultVersion

public boolean getIsDefaultVersion()

setIsDiscoverable

public void setIsDiscoverable(boolean discoverable)

getIsDiscoverable

public boolean getIsDiscoverable()

setUseDatastore

public void setUseDatastore(boolean useDatastore)

getUseDatastore

public boolean getUseDatastore()

setResource

public void setResource(java.lang.String resource)

getResource

public java.lang.String getResource()

getAuthConfig

public ApiAuthConfig getAuthConfig()

getCacheControlConfig

public ApiCacheControlConfig getCacheControlConfig()

getFrontendLimitsConfig

public ApiFrontendLimitsConfig getFrontendLimitsConfig()

getSerializationConfig

public ApiSerializationConfig getSerializationConfig()

getNamespaceConfig

public ApiNamespaceConfig getNamespaceConfig()

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()

setIssuers

public void setIssuers(ApiIssuerConfigs issuers)

ensureGoogleIssuer

public void ensureGoogleIssuer()

getIssuers

public ApiIssuerConfigs getIssuers()

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()

setApiKeyRequired

public void setApiKeyRequired(boolean apiKeyRequired)

isApiKeyRequired

public boolean isApiKeyRequired()

getApiClassConfig

public ApiClassConfig getApiClassConfig()