This value is not used directly by APIGateway but will be used for * OpenAPI exports. This will default to "awsSigV4" if your scheme is - * "aws.v4", or "custom" otherwise.
+ * {@code aws.auth#sigv4}, and if not, falls back to "custom". * * @return Returns the authType. */ public String getAuthType() { if (authType != null) { return authType; - } else if (scheme.equals("aws.v4")) { + } else if (scheme.equals(SigV4Trait.ID)) { return SIGV4_AUTH_TYPE; } else { return DEFAULT_AUTH_TYPE; @@ -190,7 +192,7 @@ public Builder toBuilder() { @Override public Node toNode() { return Node.objectNodeBuilder() - .withMember(SCHEME_KEY, Node.from(getScheme())) + .withMember(SCHEME_KEY, Node.from(getScheme().toString())) .withOptionalMember(TYPE_KEY, getType().map(Node::from)) .withOptionalMember(AUTH_TYPE_KEY, Optional.ofNullable(authType).map(Node::from)) .withOptionalMember(URI_KEY, getUri().map(Node::from)) @@ -229,7 +231,7 @@ public int hashCode() { static AuthorizerDefinition fromNode(ObjectNode node) { node.warnIfAdditionalProperties(PROPERTIES); Builder builder = builder(); - builder.scheme(node.expectStringMember(SCHEME_KEY).getValue()); + builder.scheme(node.expectStringMember(SCHEME_KEY).expectShapeId()); node.getStringMember(TYPE_KEY) .map(StringNode::getValue) .ifPresent(builder::type); @@ -259,7 +261,7 @@ static AuthorizerDefinition fromNode(ObjectNode node) { * Builder used to create an {@link AuthorizerDefinition}. */ public static final class Builder implements SmithyBuilderNamespace names are included in shape IDs sent over the wire.
+ */
+public final class AwsJson1_0Trait extends AwsProtocolTrait {
+
+ public static final ShapeId ID = ShapeId.from("aws.protocols#awsJson1_0");
+
+ private AwsJson1_0Trait(Builder builder) {
+ super(ID, builder);
+ }
+
+ public static Builder builder() {
+ return new Builder();
+ }
+
+ public static final class Builder extends AwsProtocolTrait.Builder Namespace names are stripped from shape IDs sent over the wire.
+ */
+public final class AwsJson1_1Trait extends AwsProtocolTrait {
+
+ public static final ShapeId ID = ShapeId.from("aws.protocols#awsJson1_1");
+
+ private AwsJson1_1Trait(Builder builder) {
+ super(ID, builder);
+ }
+
+ public static Builder builder() {
+ return new Builder();
+ }
+
+ public static final class Builder extends AwsProtocolTrait.Builder Subclasses are traits that allow the supported HTTP versions and
+ * eventStream HTTP versions to be customized.
+ */
+public abstract class AwsProtocolTrait extends AbstractTrait {
+
+ private static final String HTTP = "http";
+ private static final String EVENT_STREAM_HTTP = "eventStreamHttp";
+
+ private final List This protocol is deprecated. For new services, ise {@link RestJson1Trait}
+ * or {@link AwsJson1_1Trait} instead.
+ */
+public final class AwsQueryTrait extends BooleanTrait {
+
+ public static final ShapeId ID = ShapeId.from("aws.protocols#awsQuery");
+
+ public AwsQueryTrait(SourceLocation sourceLocation) {
+ super(ID, sourceLocation);
+ }
+
+ public AwsQueryTrait() {
+ this(SourceLocation.NONE);
+ }
+
+ public static final class Provider extends BooleanTrait.Provider This protocol is deprecated. For new services, ise {@link RestJson1Trait}
+ * or {@link AwsJson1_1Trait} instead.
+ */
+public final class Ec2QueryTrait extends BooleanTrait {
+
+ public static final ShapeId ID = ShapeId.from("aws.protocols#ec2Query");
+
+ public Ec2QueryTrait(SourceLocation sourceLocation) {
+ super(ID, sourceLocation);
+ }
+
+ public Ec2QueryTrait() {
+ this(SourceLocation.NONE);
+ }
+
+ public static final class Provider extends BooleanTrait.Provider This validator accepts the following optional configuration options:
- *
- * This validator accepts the following optional configuration options:
- *
- * The computed result is based on either the presence of the
- * {@code auth} trait applied to the operation, the {@code auth} trait
- * applied to the service it's bound to, or the entire list of
- * {@code auth} schemes supported by the protocols trait of the service.
- *
- * This method will return an empty List in the case of invalid or
- * missing shapes.
- *
- * @param service Service that the operation is bound to.
- * @param operation Operation to check.
- * @return Returns the computed authentication schemes.
- */
- public List The result is ordered by either the effective auth trait of the
- * operation or the list of protocols on the service.
- *
- * @param service Service that the operation is bound to.
- * @param operation Operation to check.
- * @param protocolName Protocol to limit the result.
- * @return Returns the computed authentication schemes compatible with the protocol.
- */
- public List This index can be used to get all of the protocol traits applied to
+ * a service, to get all of the auth defining traits applied to a service,
+ * to get the effective authentication schemes of a service, and to get the
+ * effective authentication schemes of an operation bound within the
+ * closure of a service.
+ */
+public final class ServiceIndex implements KnowledgeIndex {
+
+ private final WeakReference A protocol trait is a trait that is marked with
+ * the {@code smithy.api#protocolDefinition} trait.
+ *
+ * An empty map is returned if {@code service} cannot be found in the
+ * model or is not a service shape.
+ *
+ * @param service Service to get the protocols of.
+ * @return Returns a map of the protocol trait ID to the trait.
+ */
+ public Map An auth defining trait is a trait that is marked with
+ * the {@code smithy.api#authDefinition} trait.
+ *
+ * An empty map is returned if {@code id} cannot be found in the
+ * model or is not a service shape.
+ *
+ * @param service Service to get the auth schemes of.
+ * @return Returns a map of the trait shape ID to the auth trait itself.
+ */
+ public Map An effective authentication scheme is derived from the
+ * {@code smithy.api#auth} trait and the auth defining traits applied
+ * to a service. If the service has the {@code smithy.api#auth} trait,
+ * then a map is returned that contains the traits applied to the service
+ * that matches the values in the auth trait. If no auth trait is applied,
+ * then all of the auth defining traits on the service are returned.
+ *
+ * The returned map is provided in the same order as the values in the
+ * {@code auth} trait if an auth trait is present, otherwise the result
+ * is returned in an undefined order.
+ *
+ * An empty map is returned if {@code service} cannot be found in the
+ * model or is not a service shape.
+ *
+ * @param service Service to get the effective authentication schemes of.
+ * @return Returns a map of the trait shape ID to the auth trait itself.
+ */
+ public Map If the given operation defines that {@code smithy.api#auth} trait,
+ * then a map is returned that consists of the traits applied to the
+ * service that match the values of the {@code smithy.api#auth} trait. If
+ * the operation does not define an {@code smithy.api#auth} trait, then
+ * the effective auth schemes of the service is returned (that is, the
+ * return value of {@link #getEffectiveAuthSchemes(ToShapeId)}).
+ *
+ * The returned map is provided in the same order as the values in the
+ * {@code auth} trait if an auth trait is present, otherwise the result
+ * is returned in an undefined order.
+ *
+ * An empty map is returned if {@code service} shape cannot be found
+ * in the model or is not a service shape. An empty map is returned if
+ * {@code operation} cannot be found in the model or is not an operation
+ * shape.
+ *
+ * @param service Service the operation is within.
+ * @param operation Operation to get the effective authentication schemes of.
+ * @return Returns a map of the trait shape ID to the auth trait itself.
+ */
+ public Map
- *
- */
-public final class DeprecatedAuthSchemesValidator extends AbstractValidator {
- private static final List
- *
- */
-public final class DeprecatedProtocolsValidator extends AbstractValidator {
- private static final List