com.google.api.tools.framework.aspects.http.model

Class HttpAttribute

java.lang.Object

com.google.api.tools.framework.aspects.http.model.HttpAttribute

public class HttpAttribute
extends java.lang.Object

Describes the mapping of of a method to HTTP. Attached by the aspects to methods which do have an http configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpAttribute.FieldSegment A path segment representing a field reference.
static class	HttpAttribute.LiteralSegment A path segment representing a literal.
static class	HttpAttribute.PathSegment Base class for path segments.
static class	HttpAttribute.WildcardSegment A path segment representing a wildcard, which is bounded (matches 1 segment) or unbounded (matches 1 or more segments).

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.inject.Key<HttpAttribute>	KEY Key used to access this attribute.

Constructor Summary

Constructors

Constructor and Description
HttpAttribute(com.google.api.HttpRule rule, MethodKind methodKind, MessageType message, com.google.common.collect.ImmutableList<HttpAttribute.PathSegment> path, java.lang.String body, boolean isFromIdl, com.google.common.collect.ImmutableList<HttpAttribute> additionalBindings, boolean isPrimary) Constructs an http binding for the given method kind, message, path, and body.

Method Summary

Modifier and Type	Method and Description
boolean	bodyCapturesUnboundFields() Returns true if the body is configured to include unbound fields.
com.google.common.collect.ImmutableList<HttpAttribute>	getAdditionalBindings()
java.lang.Iterable<HttpAttribute>	getAllBindings() Returns an Iterable that includes the primary binding (the current one) and all additional bindings.
java.lang.String	getAnySpecifiedFieldInHttpRule() Returns the name of the any field specified in the underlying http rule.
java.lang.String	getBody() Gets the body or null if none specified.
com.google.common.collect.ImmutableList<FieldSelector>	getBodySelectors() Get fields which are bound via the body.
com.google.common.collect.ImmutableList<HttpAttribute.PathSegment>	getFlatPath() Gets the flattened path, where all FieldSegments have been replaced by their sub-paths.
com.google.api.HttpRule	getHttpRule() Gets the underlying http rule.
MessageType	getMessage() Gets the request message this configuration is associated with.
MethodKind	getMethodKind() Gets the http method kind.
com.google.common.collect.ImmutableList<FieldSelector>	getParamSelectors() Gets fields which are bound via parameters.
com.google.common.collect.ImmutableList<HttpAttribute.PathSegment>	getPath() Gets the path as a list of segments.
com.google.common.collect.ImmutableList<FieldSelector>	getPathSelectors() Gets the fields which are bound via the path.
RestMethod	getRestMethod() Returns the associated rest method.
com.google.common.collect.ImmutableList<FieldSelector>	getVisibleBodySelectors() Gets visible fields which are bound via body.
com.google.common.collect.ImmutableList<FieldSelector>	getVisibleParamSelectors() Gets visible fields which are bound via parameters.
com.google.common.collect.ImmutableList<FieldSelector>	getVisiblePathSelectors() Gets visible fields which are bound via the path.
boolean	isFromIdl() Return true if the http binding information is from IDL.
boolean	isPrimary() Returns true if this is the primary binding.
static HttpAttribute	noConfig(MessageType message) Creates an empty binding for a method which is not exposed via http.
HttpAttribute	reroot(java.lang.String newRoot) Create a new HTTP binding where the HTTP paths are rooted underneath the provided path.
void	setFields(com.google.common.collect.ImmutableList<FieldSelector> paramFields, com.google.common.collect.ImmutableList<FieldSelector> bodyFields) Sets the parameter and body fields.
void	setRestMethod(RestMethod method) Sets the rest method.

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final com.google.inject.Key<HttpAttribute> KEY

Key used to access this attribute.

Constructor Detail

HttpAttribute

public HttpAttribute(com.google.api.HttpRule rule,
                     MethodKind methodKind,
                     MessageType message,
                     com.google.common.collect.ImmutableList<HttpAttribute.PathSegment> path,
                     java.lang.String body,
                     boolean isFromIdl,
                     com.google.common.collect.ImmutableList<HttpAttribute> additionalBindings,
                     boolean isPrimary)

Constructs an http binding for the given method kind, message, path, and body. See documentation of the getters for the meaning of those values.

Method Detail

noConfig

public static HttpAttribute noConfig(MessageType message)

Creates an empty binding for a method which is not exposed via http.

getAnySpecifiedFieldInHttpRule

public java.lang.String getAnySpecifiedFieldInHttpRule()

Returns the name of the any field specified in the underlying http rule.

isPrimary

public boolean isPrimary()

Returns true if this is the primary binding.

getRestMethod

public RestMethod getRestMethod()

Returns the associated rest method. Each HTTP binding has one.

setRestMethod

public void setRestMethod(RestMethod method)

Sets the rest method.

reroot

public HttpAttribute reroot(java.lang.String newRoot)

Create a new HTTP binding where the HTTP paths are rooted underneath the provided path. replaces the first segment in the path by the list of literal segments obtained from the newRoot parameter.

getAllBindings

public java.lang.Iterable<HttpAttribute> getAllBindings()

Returns an Iterable that includes the primary binding (the current one) and all additional bindings. The primary binding is always the first item in the Iterable.

getHttpRule

public com.google.api.HttpRule getHttpRule()

Gets the underlying http rule.

getMethodKind

public MethodKind getMethodKind()

Gets the http method kind.

getMessage

public MessageType getMessage()

Gets the request message this configuration is associated with.

getPath

public com.google.common.collect.ImmutableList<HttpAttribute.PathSegment> getPath()

Gets the path as a list of segments.

getFlatPath

public com.google.common.collect.ImmutableList<HttpAttribute.PathSegment> getFlatPath()

Gets the flattened path, where all FieldSegments have been replaced by their sub-paths.

getBody

public java.lang.String getBody()

Gets the body or null if none specified.

isFromIdl

public boolean isFromIdl()

Return true if the http binding information is from IDL.

bodyCapturesUnboundFields

public boolean bodyCapturesUnboundFields()

Returns true if the body is configured to include unbound fields.

getPathSelectors

public com.google.common.collect.ImmutableList<FieldSelector> getPathSelectors()

Gets the fields which are bound via the path.

getParamSelectors

public com.google.common.collect.ImmutableList<FieldSelector> getParamSelectors()

Gets fields which are bound via parameters.

getBodySelectors

public com.google.common.collect.ImmutableList<FieldSelector> getBodySelectors()

Get fields which are bound via the body.

setFields

public void setFields(com.google.common.collect.ImmutableList<FieldSelector> paramFields,
                      com.google.common.collect.ImmutableList<FieldSelector> bodyFields)

Sets the parameter and body fields. Also derives the path fields from the path, assuming they have been resolved.

getVisiblePathSelectors

public com.google.common.collect.ImmutableList<FieldSelector> getVisiblePathSelectors()

Gets visible fields which are bound via the path.

getVisibleParamSelectors

public com.google.common.collect.ImmutableList<FieldSelector> getVisibleParamSelectors()

Gets visible fields which are bound via parameters.

getVisibleBodySelectors

public com.google.common.collect.ImmutableList<FieldSelector> getVisibleBodySelectors()

Gets visible fields which are bound via body.

getAdditionalBindings

public com.google.common.collect.ImmutableList<HttpAttribute> getAdditionalBindings()