blob: 5a50a30078094e754ba70b850a1b0930c5e9b81e [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.builder.component.dsl;
import javax.annotation.Generated;
import org.apache.camel.Component;
import org.apache.camel.builder.component.AbstractComponentBuilder;
import org.apache.camel.builder.component.ComponentBuilder;
import org.apache.camel.component.aws2.sts.STS2Component;
/**
* Manage AWS STS cluster instances using AWS SDK version 2.x.
*
* Generated by camel-package-maven-plugin - do not edit this file!
*/
@Generated("org.apache.camel.maven.packaging.ComponentDslMojo")
public interface Aws2StsComponentBuilderFactory {
/**
* AWS 2 Security Token Service (STS) (camel-aws2-sts)
* Manage AWS STS cluster instances using AWS SDK version 2.x.
*
* Category: cloud,management
* Since: 3.5
* Maven coordinates: org.apache.camel:camel-aws2-sts
*/
static Aws2StsComponentBuilder aws2Sts() {
return new Aws2StsComponentBuilderImpl();
}
/**
* Builder for the AWS 2 Security Token Service (STS) component.
*/
interface Aws2StsComponentBuilder extends ComponentBuilder<STS2Component> {
/**
* Setting the autoDiscoverClient mechanism, if true, the component will
* look for a client instance in the registry automatically otherwise it
* will skip that checking.
*
* The option is a: <code>boolean</code> type.
*
* Default: true
* Group: common
*/
default Aws2StsComponentBuilder autoDiscoverClient(
boolean autoDiscoverClient) {
doSetProperty("autoDiscoverClient", autoDiscoverClient);
return this;
}
/**
* Component configuration.
*
* The option is a:
* <code>org.apache.camel.component.aws2.sts.STS2Configuration</code>
* type.
*
* Group: producer
*/
default Aws2StsComponentBuilder configuration(
org.apache.camel.component.aws2.sts.STS2Configuration configuration) {
doSetProperty("configuration", configuration);
return this;
}
/**
* Whether the producer should be started lazy (on the first message).
* By starting lazy you can use this to allow CamelContext and routes to
* startup in situations where a producer may otherwise fail during
* starting and cause the route to fail being started. By deferring this
* startup to be lazy then the startup failure can be handled during
* routing messages via Camel's routing error handlers. Beware that when
* the first message is processed then creating and starting the
* producer may take a little time and prolong the total processing time
* of the processing.
*
* The option is a: <code>boolean</code> type.
*
* Default: false
* Group: producer
*/
default Aws2StsComponentBuilder lazyStartProducer(
boolean lazyStartProducer) {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
/**
* The operation to perform.
*
* The option is a:
* <code>org.apache.camel.component.aws2.sts.STS2Operations</code> type.
*
* Default: assumeRole
* Group: producer
*/
default Aws2StsComponentBuilder operation(
org.apache.camel.component.aws2.sts.STS2Operations operation) {
doSetProperty("operation", operation);
return this;
}
/**
* If we want to use a POJO request as body or not.
*
* The option is a: <code>boolean</code> type.
*
* Default: false
* Group: producer
*/
default Aws2StsComponentBuilder pojoRequest(boolean pojoRequest) {
doSetProperty("pojoRequest", pojoRequest);
return this;
}
/**
* To define a proxy host when instantiating the STS client.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: producer
*/
default Aws2StsComponentBuilder proxyHost(java.lang.String proxyHost) {
doSetProperty("proxyHost", proxyHost);
return this;
}
/**
* To define a proxy port when instantiating the STS client.
*
* The option is a: <code>java.lang.Integer</code> type.
*
* Group: producer
*/
default Aws2StsComponentBuilder proxyPort(java.lang.Integer proxyPort) {
doSetProperty("proxyPort", proxyPort);
return this;
}
/**
* To define a proxy protocol when instantiating the STS client.
*
* The option is a: <code>software.amazon.awssdk.core.Protocol</code>
* type.
*
* Default: HTTPS
* Group: producer
*/
default Aws2StsComponentBuilder proxyProtocol(
software.amazon.awssdk.core.Protocol proxyProtocol) {
doSetProperty("proxyProtocol", proxyProtocol);
return this;
}
/**
* The region in which STS client needs to work. When using this
* parameter, the configuration will expect the lowercase name of the
* region (for example ap-east-1) You'll need to use the name
* Region.EU_WEST_1.id().
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: producer
*/
default Aws2StsComponentBuilder region(java.lang.String region) {
doSetProperty("region", region);
return this;
}
/**
* To use a existing configured AWS STS as client.
*
* The option is a:
* <code>software.amazon.awssdk.services.sts.StsClient</code> type.
*
* Group: producer
*/
default Aws2StsComponentBuilder stsClient(
software.amazon.awssdk.services.sts.StsClient stsClient) {
doSetProperty("stsClient", stsClient);
return this;
}
/**
* If we want to trust all certificates in case of overriding the
* endpoint.
*
* The option is a: <code>boolean</code> type.
*
* Default: false
* Group: producer
*/
default Aws2StsComponentBuilder trustAllCertificates(
boolean trustAllCertificates) {
doSetProperty("trustAllCertificates", trustAllCertificates);
return this;
}
/**
* Whether the component should use basic property binding (Camel 2.x)
* or the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Default: false
* Group: advanced
*/
default Aws2StsComponentBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Amazon AWS Access Key.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: security
*/
default Aws2StsComponentBuilder accessKey(java.lang.String accessKey) {
doSetProperty("accessKey", accessKey);
return this;
}
/**
* Amazon AWS Secret Key.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: security
*/
default Aws2StsComponentBuilder secretKey(java.lang.String secretKey) {
doSetProperty("secretKey", secretKey);
return this;
}
}
class Aws2StsComponentBuilderImpl
extends
AbstractComponentBuilder<STS2Component>
implements
Aws2StsComponentBuilder {
@Override
protected STS2Component buildConcreteComponent() {
return new STS2Component();
}
private org.apache.camel.component.aws2.sts.STS2Configuration getOrCreateConfiguration(
org.apache.camel.component.aws2.sts.STS2Component component) {
if (component.getConfiguration() == null) {
component.setConfiguration(new org.apache.camel.component.aws2.sts.STS2Configuration());
}
return component.getConfiguration();
}
@Override
protected boolean setPropertyOnComponent(
Component component,
String name,
Object value) {
switch (name) {
case "autoDiscoverClient": getOrCreateConfiguration((STS2Component) component).setAutoDiscoverClient((boolean) value); return true;
case "configuration": ((STS2Component) component).setConfiguration((org.apache.camel.component.aws2.sts.STS2Configuration) value); return true;
case "lazyStartProducer": ((STS2Component) component).setLazyStartProducer((boolean) value); return true;
case "operation": getOrCreateConfiguration((STS2Component) component).setOperation((org.apache.camel.component.aws2.sts.STS2Operations) value); return true;
case "pojoRequest": getOrCreateConfiguration((STS2Component) component).setPojoRequest((boolean) value); return true;
case "proxyHost": getOrCreateConfiguration((STS2Component) component).setProxyHost((java.lang.String) value); return true;
case "proxyPort": getOrCreateConfiguration((STS2Component) component).setProxyPort((java.lang.Integer) value); return true;
case "proxyProtocol": getOrCreateConfiguration((STS2Component) component).setProxyProtocol((software.amazon.awssdk.core.Protocol) value); return true;
case "region": getOrCreateConfiguration((STS2Component) component).setRegion((java.lang.String) value); return true;
case "stsClient": getOrCreateConfiguration((STS2Component) component).setStsClient((software.amazon.awssdk.services.sts.StsClient) value); return true;
case "trustAllCertificates": getOrCreateConfiguration((STS2Component) component).setTrustAllCertificates((boolean) value); return true;
case "basicPropertyBinding": ((STS2Component) component).setBasicPropertyBinding((boolean) value); return true;
case "accessKey": getOrCreateConfiguration((STS2Component) component).setAccessKey((java.lang.String) value); return true;
case "secretKey": getOrCreateConfiguration((STS2Component) component).setSecretKey((java.lang.String) value); return true;
default: return false;
}
}
}
}