com.google.api.server.spi

Class ServiceContext

java.lang.Object

com.google.api.server.spi.ServiceContext

public class ServiceContext
extends java.lang.Object

Provides context for a service class when its API configuration is being generated.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_API_NAME API name to use when it is not provided or inferred.
static java.lang.String	DEFAULT_APP_NAME Application name to use when it is not provided or inferred.

Method Summary

Modifier and Type	Method and Description
static ServiceContext	create() Creates a service context with default application and API name.
static ServiceContext	create(java.lang.String applicationId, java.lang.String apiName) Creates a service context with a given default application and API name.
static ServiceContext	createFromHostname(java.lang.String hostname, java.lang.String apiName)
java.lang.String	getAppHostname()
java.lang.String	getDefaultApiName()
java.lang.String	getTransferProtocol()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_API_NAME

public static final java.lang.String DEFAULT_API_NAME

API name to use when it is not provided or inferred.

See Also:

Constant Field Values

DEFAULT_APP_NAME

public static final java.lang.String DEFAULT_APP_NAME

Application name to use when it is not provided or inferred.

See Also:

Constant Field Values

Method Detail

create

public static ServiceContext create()

Creates a service context with default application and API name.

create

public static ServiceContext create(java.lang.String applicationId,
                                    java.lang.String apiName)

Creates a service context with a given default application and API name.

Parameters:

applicationId - Default application id to use. Format is either "<appName>" or "google.com:<appName>", where the host name of the former is "<appName>.appspot.com" and ther latter is "<appName>.googleplex.com".

apiName - Default API name to use.

createFromHostname

public static ServiceContext createFromHostname(java.lang.String hostname,
                                                java.lang.String apiName)

getDefaultApiName

public java.lang.String getDefaultApiName()

getAppHostname

public java.lang.String getAppHostname()

getTransferProtocol

public java.lang.String getTransferProtocol()