com.google.api.server.spi.discovery

Class LocalDiscoveryProvider

java.lang.Object

com.google.api.server.spi.discovery.LocalDiscoveryProvider

All Implemented Interfaces:

DiscoveryProvider

public class LocalDiscoveryProvider
extends java.lang.Object

A DiscoveryProvider which generates discovery documents locally.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
LocalDiscoveryProvider(com.google.common.collect.ImmutableList<ApiConfig> apiConfigs, DiscoveryGenerator generator, SchemaRepository repository)

Method Summary

Modifier and Type	Method and Description
com.google.api.services.discovery.model.DirectoryList	getDirectory(java.lang.String root) Gets a list of REST discovery documents hosted by the current server.
com.google.api.services.discovery.model.RestDescription	getRestDocument(java.lang.String root, java.lang.String name, java.lang.String version) Gets a REST discovery document for an API.
com.google.api.services.discovery.model.RpcDescription	getRpcDocument(java.lang.String root, java.lang.String name, java.lang.String version) Gets an RPC discovery document for an API.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final java.util.logging.Logger logger

Constructor Detail

LocalDiscoveryProvider

public LocalDiscoveryProvider(com.google.common.collect.ImmutableList<ApiConfig> apiConfigs,
                              DiscoveryGenerator generator,
                              SchemaRepository repository)

Method Detail

getRestDocument

public com.google.api.services.discovery.model.RestDescription getRestDocument(java.lang.String root,
                                                                               java.lang.String name,
                                                                               java.lang.String version)
                                                                        throws NotFoundException

Description copied from interface: DiscoveryProvider

Gets a REST discovery document for an API.

Throws:

NotFoundException - if the API doesn't exist

getRpcDocument

public com.google.api.services.discovery.model.RpcDescription getRpcDocument(java.lang.String root,
                                                                             java.lang.String name,
                                                                             java.lang.String version)
                                                                      throws NotFoundException

Description copied from interface: DiscoveryProvider

Gets an RPC discovery document for an API.

Throws:

NotFoundException - if the API doesn't exist

getDirectory

public com.google.api.services.discovery.model.DirectoryList getDirectory(java.lang.String root)

Description copied from interface: DiscoveryProvider

Gets a list of REST discovery documents hosted by the current server. This method will never return RPC discovery documents, as everything that uses online discovery uses the REST discovery doc (API explorer, Python and JavaScript client, etc).