com.google.api.server.spi.discovery

Class CachingDiscoveryProvider

java.lang.Object

com.google.api.server.spi.discovery.CachingDiscoveryProvider

All Implemented Interfaces:

DiscoveryProvider

public class CachingDiscoveryProvider
extends java.lang.Object
implements DiscoveryProvider

A DiscoveryProvider that caches results and delegates computation to another provider.

Constructor Summary

Constructors

Constructor and Description
CachingDiscoveryProvider(DiscoveryProvider delegate)
CachingDiscoveryProvider(DiscoveryProvider delegate, long cacheExpiry, java.util.concurrent.TimeUnit cacheExpiryUnit)

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

Constructor Detail

CachingDiscoveryProvider

public CachingDiscoveryProvider(DiscoveryProvider delegate)

CachingDiscoveryProvider

public CachingDiscoveryProvider(DiscoveryProvider delegate,
                                long cacheExpiry,
                                java.util.concurrent.TimeUnit cacheExpiryUnit)

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,
                                                                               InternalServerErrorException

Description copied from interface: DiscoveryProvider

Gets a REST discovery document for an API.

Specified by:

getRestDocument in interface DiscoveryProvider

Throws:

NotFoundException - if the API doesn't exist

InternalServerErrorException - an error takes place when getting the document

getRpcDocument

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

Description copied from interface: DiscoveryProvider

Gets an RPC discovery document for an API.

Specified by:

getRpcDocument in interface DiscoveryProvider

Throws:

NotFoundException - if the API doesn't exist

InternalServerErrorException - an error takes place when getting the document

getDirectory

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

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

Specified by:

getDirectory in interface DiscoveryProvider

Throws:

InternalServerErrorException